Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. fsx
  6. Volume

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.fsx.Volume

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::FSx::Volume

    Create Volume Resource

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

    Constructor syntax

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

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           backup_id: Optional[str] = None,
           name: Optional[str] = None,
           ontap_configuration: Optional[VolumeOntapConfigurationArgs] = None,
           open_zfs_configuration: Optional[VolumeOpenZfsConfigurationArgs] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           volume_type: Optional[str] = None)
    func NewVolume(ctx *Context, name string, args *VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs? args = null, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

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


    resource "aws-native_fsx_volume" "name" {
    # resource properties
}

    Parameters

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

    Volume 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 Volume resource accepts the following input properties:

    BackupId string
    Specifies the ID of the volume backup to use to create a new volume.
    Name string
    The name of the volume.
    OntapConfiguration Pulumi.AwsNative.FSx.Inputs.VolumeOntapConfiguration
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    OpenZfsConfiguration Pulumi.AwsNative.FSx.Inputs.VolumeOpenZfsConfiguration
    The configuration of an Amazon FSx for OpenZFS volume.
    Tags List<Pulumi.AwsNative.Inputs.Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    VolumeType string
    The type of the volume.
    BackupId string
    Specifies the ID of the volume backup to use to create a new volume.
    Name string
    The name of the volume.
    OntapConfiguration VolumeOntapConfigurationArgs
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    OpenZfsConfiguration VolumeOpenZfsConfigurationArgs
    The configuration of an Amazon FSx for OpenZFS volume.
    Tags TagArgs

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    VolumeType string
    The type of the volume.
    backup_id string
    Specifies the ID of the volume backup to use to create a new volume.
    name string
    The name of the volume.
    ontap_configuration object
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    open_zfs_configuration object
    The configuration of an Amazon FSx for OpenZFS volume.
    tags list(object)

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    volume_type string
    The type of the volume.
    backupId String
    Specifies the ID of the volume backup to use to create a new volume.
    name String
    The name of the volume.
    ontapConfiguration VolumeOntapConfiguration
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    openZfsConfiguration VolumeOpenZfsConfiguration
    The configuration of an Amazon FSx for OpenZFS volume.
    tags List<Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    volumeType String
    The type of the volume.
    backupId string
    Specifies the ID of the volume backup to use to create a new volume.
    name string
    The name of the volume.
    ontapConfiguration VolumeOntapConfiguration
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    openZfsConfiguration VolumeOpenZfsConfiguration
    The configuration of an Amazon FSx for OpenZFS volume.
    tags Tag[]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    volumeType string
    The type of the volume.
    backup_id str
    Specifies the ID of the volume backup to use to create a new volume.
    name str
    The name of the volume.
    ontap_configuration VolumeOntapConfigurationArgs
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    open_zfs_configuration VolumeOpenZfsConfigurationArgs
    The configuration of an Amazon FSx for OpenZFS volume.
    tags Sequence[TagArgs]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    volume_type str
    The type of the volume.
    backupId String
    Specifies the ID of the volume backup to use to create a new volume.
    name String
    The name of the volume.
    ontapConfiguration Property Map
    The configuration of an Amazon FSx for NetApp ONTAP volume.
    openZfsConfiguration Property Map
    The configuration of an Amazon FSx for OpenZFS volume.
    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    volumeType String
    The type of the volume.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceArn string

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    Uuid string

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    VolumeId string

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceArn string

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    Uuid string

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    VolumeId string

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    id string
    The provider-assigned unique ID for this managed resource.
    resource_arn string

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    uuid string

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    volume_id string

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    id String
    The provider-assigned unique ID for this managed resource.
    resourceArn String

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    uuid String

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    volumeId String

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    id string
    The provider-assigned unique ID for this managed resource.
    resourceArn string

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    uuid string

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    volumeId string

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    id str
    The provider-assigned unique ID for this managed resource.
    resource_arn str

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    uuid str

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    volume_id str

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    id String
    The provider-assigned unique ID for this managed resource.
    resourceArn String

    Returns the volume's Amazon Resource Name (ARN).

    Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

    uuid String

    Returns the volume's universally unique identifier (UUID).

    Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    volumeId String

    Returns the volume's ID.

    Example: fsvol-0123456789abcdefa

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    VolumeAggregateConfiguration, VolumeAggregateConfigurationArgs

    Aggregates List<string>

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    ConstituentsPerAggregate int
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
    Aggregates []string

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    ConstituentsPerAggregate int
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
    aggregates list(string)

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    constituents_per_aggregate number
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
    aggregates List<String>

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    constituentsPerAggregate Integer
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
    aggregates string[]

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    constituentsPerAggregate number
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
    aggregates Sequence[str]

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    constituents_per_aggregate int
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
    aggregates List<String>

    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

    • The strings in the value of Aggregates are not are not formatted as aggrX , where X is a number between 1 and 12.
    • The value of Aggregates contains aggregates that are not present.
    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    constituentsPerAggregate Number
    Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.

    VolumeAutocommitPeriod, VolumeAutocommitPeriodArgs

    Type string
    Defines 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. The default value is NONE .
    Value int
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10
    Type string
    Defines 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. The default value is NONE .
    Value int
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10
    type string
    Defines 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. The default value is NONE .
    value number
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10
    type String
    Defines 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. The default value is NONE .
    value Integer
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10
    type string
    Defines 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. The default value is NONE .
    value number
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10
    type str
    Defines 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. The default value is NONE .
    value int
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10
    type String
    Defines 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. The default value is NONE .
    value Number
    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

    • Minutes : 5 - 65,535
    • Hours : 1 - 65,535
    • Days : 1 - 3,650
    • Months : 1 - 120
    • Years : 1 - 10

    VolumeClientConfigurations, VolumeClientConfigurationsArgs

    Clients string
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    Options List<string>
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
    Clients string
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    Options []string
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
    clients string
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    options list(string)
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
    clients String
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    options List<String>
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
    clients string
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    options string[]
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
    clients str
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    options Sequence[str]
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
    clients String
    A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
    options List<String>
    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
    • sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

    VolumeNfsExports, VolumeNfsExportsArgs

    ClientConfigurations List<Pulumi.AwsNative.FSx.Inputs.VolumeClientConfigurations>
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
    ClientConfigurations []VolumeClientConfigurations
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
    client_configurations list(object)
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
    clientConfigurations List<VolumeClientConfigurations>
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
    clientConfigurations VolumeClientConfigurations[]
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
    client_configurations Sequence[VolumeClientConfigurations]
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
    clientConfigurations List<Property Map>
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

    VolumeOntapConfiguration, VolumeOntapConfigurationArgs

    StorageVirtualMachineId string
    Specifies the ONTAP SVM in which to create the volume.
    AggregateConfiguration Pulumi.AwsNative.FSx.Inputs.VolumeAggregateConfiguration
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    CopyTagsToBackups string
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    JunctionPath string
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    OntapVolumeType string

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    SecurityStyle string

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    SizeInBytes string
    Specifies the configured size of the volume, in bytes.
    SizeInMegabytes string
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    SnaplockConfiguration Pulumi.AwsNative.FSx.Inputs.VolumeSnaplockConfiguration
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    SnapshotPolicy string

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    StorageEfficiencyEnabled string

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    TieringPolicy Pulumi.AwsNative.FSx.Inputs.VolumeTieringPolicy

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    VolumeStyle string
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
    StorageVirtualMachineId string
    Specifies the ONTAP SVM in which to create the volume.
    AggregateConfiguration VolumeAggregateConfiguration
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    CopyTagsToBackups string
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    JunctionPath string
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    OntapVolumeType string

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    SecurityStyle string

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    SizeInBytes string
    Specifies the configured size of the volume, in bytes.
    SizeInMegabytes string
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    SnaplockConfiguration VolumeSnaplockConfiguration
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    SnapshotPolicy string

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    StorageEfficiencyEnabled string

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    TieringPolicy VolumeTieringPolicy

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    VolumeStyle string
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
    storage_virtual_machine_id string
    Specifies the ONTAP SVM in which to create the volume.
    aggregate_configuration object
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    copy_tags_to_backups string
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    junction_path string
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    ontap_volume_type string

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    security_style string

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    size_in_bytes string
    Specifies the configured size of the volume, in bytes.
    size_in_megabytes string
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    snaplock_configuration object
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    snapshot_policy string

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    storage_efficiency_enabled string

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    tiering_policy object

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    volume_style string
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
    storageVirtualMachineId String
    Specifies the ONTAP SVM in which to create the volume.
    aggregateConfiguration VolumeAggregateConfiguration
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    copyTagsToBackups String
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    junctionPath String
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    ontapVolumeType String

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    securityStyle String

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    sizeInBytes String
    Specifies the configured size of the volume, in bytes.
    sizeInMegabytes String
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    snaplockConfiguration VolumeSnaplockConfiguration
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    snapshotPolicy String

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    storageEfficiencyEnabled String

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    tieringPolicy VolumeTieringPolicy

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    volumeStyle String
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
    storageVirtualMachineId string
    Specifies the ONTAP SVM in which to create the volume.
    aggregateConfiguration VolumeAggregateConfiguration
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    copyTagsToBackups string
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    junctionPath string
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    ontapVolumeType string

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    securityStyle string

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    sizeInBytes string
    Specifies the configured size of the volume, in bytes.
    sizeInMegabytes string
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    snaplockConfiguration VolumeSnaplockConfiguration
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    snapshotPolicy string

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    storageEfficiencyEnabled string

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    tieringPolicy VolumeTieringPolicy

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    volumeStyle string
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
    storage_virtual_machine_id str
    Specifies the ONTAP SVM in which to create the volume.
    aggregate_configuration VolumeAggregateConfiguration
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    copy_tags_to_backups str
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    junction_path str
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    ontap_volume_type str

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    security_style str

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    size_in_bytes str
    Specifies the configured size of the volume, in bytes.
    size_in_megabytes str
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    snaplock_configuration VolumeSnaplockConfiguration
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    snapshot_policy str

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    storage_efficiency_enabled str

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    tiering_policy VolumeTieringPolicy

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    volume_style str
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
    storageVirtualMachineId String
    Specifies the ONTAP SVM in which to create the volume.
    aggregateConfiguration Property Map
    Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
    copyTagsToBackups String
    A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
    junctionPath String
    Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .
    ontapVolumeType String

    Specifies the type of volume you are creating. Valid values are the following:

    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

    securityStyle String

    Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

    • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
    • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
    • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

    For more information, see Volume security style in the FSx for ONTAP User Guide.

    sizeInBytes String
    Specifies the configured size of the volume, in bytes.
    sizeInMegabytes String
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    snaplockConfiguration Property Map
    The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    snapshotPolicy String

    Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

    • default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

    For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

    storageEfficiencyEnabled String

    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

    StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

    tieringPolicy Property Map

    Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

    Valid tiering policies are the following:

    • SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    volumeStyle String
    Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

    VolumeOpenZfsConfiguration, VolumeOpenZfsConfigurationArgs

    ParentVolumeId string
    The ID of the volume to use as the parent volume of the volume that you are creating.
    CopyTagsToSnapshots bool
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    DataCompressionType string
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    NfsExports List<Pulumi.AwsNative.FSx.Inputs.VolumeNfsExports>
    The configuration object for mounting a Network File System (NFS) file system.
    Options List<string>
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    OriginSnapshot Pulumi.AwsNative.FSx.Inputs.VolumeOriginSnapshot
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    ReadOnly bool
    A Boolean value indicating whether the volume is read-only.
    RecordSizeKiB int
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    StorageCapacityQuotaGiB int

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    StorageCapacityReservationGiB int
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    UserAndGroupQuotas List<Pulumi.AwsNative.FSx.Inputs.VolumeUserAndGroupQuotas>
    Configures how much storage users and groups can use on the volume.
    ParentVolumeId string
    The ID of the volume to use as the parent volume of the volume that you are creating.
    CopyTagsToSnapshots bool
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    DataCompressionType string
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    NfsExports []VolumeNfsExports
    The configuration object for mounting a Network File System (NFS) file system.
    Options []string
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    OriginSnapshot VolumeOriginSnapshot
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    ReadOnly bool
    A Boolean value indicating whether the volume is read-only.
    RecordSizeKiB int
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    StorageCapacityQuotaGiB int

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    StorageCapacityReservationGiB int
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    UserAndGroupQuotas []VolumeUserAndGroupQuotas
    Configures how much storage users and groups can use on the volume.
    parent_volume_id string
    The ID of the volume to use as the parent volume of the volume that you are creating.
    copy_tags_to_snapshots bool
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    data_compression_type string
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    nfs_exports list(object)
    The configuration object for mounting a Network File System (NFS) file system.
    options list(string)
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    origin_snapshot object
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    read_only bool
    A Boolean value indicating whether the volume is read-only.
    record_size_ki_b number
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    storage_capacity_quota_gi_b number

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    storage_capacity_reservation_gi_b number
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    user_and_group_quotas list(object)
    Configures how much storage users and groups can use on the volume.
    parentVolumeId String
    The ID of the volume to use as the parent volume of the volume that you are creating.
    copyTagsToSnapshots Boolean
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    dataCompressionType String
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    nfsExports List<VolumeNfsExports>
    The configuration object for mounting a Network File System (NFS) file system.
    options List<String>
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    originSnapshot VolumeOriginSnapshot
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    readOnly Boolean
    A Boolean value indicating whether the volume is read-only.
    recordSizeKiB Integer
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    storageCapacityQuotaGiB Integer

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    storageCapacityReservationGiB Integer
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    userAndGroupQuotas List<VolumeUserAndGroupQuotas>
    Configures how much storage users and groups can use on the volume.
    parentVolumeId string
    The ID of the volume to use as the parent volume of the volume that you are creating.
    copyTagsToSnapshots boolean
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    dataCompressionType string
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    nfsExports VolumeNfsExports[]
    The configuration object for mounting a Network File System (NFS) file system.
    options string[]
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    originSnapshot VolumeOriginSnapshot
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    readOnly boolean
    A Boolean value indicating whether the volume is read-only.
    recordSizeKiB number
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    storageCapacityQuotaGiB number

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    storageCapacityReservationGiB number
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    userAndGroupQuotas VolumeUserAndGroupQuotas[]
    Configures how much storage users and groups can use on the volume.
    parent_volume_id str
    The ID of the volume to use as the parent volume of the volume that you are creating.
    copy_tags_to_snapshots bool
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    data_compression_type str
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    nfs_exports Sequence[VolumeNfsExports]
    The configuration object for mounting a Network File System (NFS) file system.
    options Sequence[str]
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    origin_snapshot VolumeOriginSnapshot
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    read_only bool
    A Boolean value indicating whether the volume is read-only.
    record_size_ki_b int
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    storage_capacity_quota_gi_b int

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    storage_capacity_reservation_gi_b int
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    user_and_group_quotas Sequence[VolumeUserAndGroupQuotas]
    Configures how much storage users and groups can use on the volume.
    parentVolumeId String
    The ID of the volume to use as the parent volume of the volume that you are creating.
    copyTagsToSnapshots Boolean
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
    dataCompressionType String
    Specifies the method used to compress the data on the volume. The compression type is NONE by default.

    • NONE - Doesn't compress the data on the volume. NONE is the default.
    • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
    • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
    nfsExports List<Property Map>
    The configuration object for mounting a Network File System (NFS) file system.
    options List<String>
    To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
    originSnapshot Property Map
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    readOnly Boolean
    A Boolean value indicating whether the volume is read-only.
    recordSizeKiB Number
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
    storageCapacityQuotaGiB Number

    Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

    For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

    storageCapacityReservationGiB Number
    Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
    userAndGroupQuotas List<Property Map>
    Configures how much storage users and groups can use on the volume.

    VolumeOriginSnapshot, VolumeOriginSnapshotArgs

    CopyStrategy string

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    SnapshotArn string
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.
    CopyStrategy string

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    SnapshotArn string
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.
    copy_strategy string

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    snapshot_arn string
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.
    copyStrategy String

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    snapshotArn String
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.
    copyStrategy string

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    snapshotArn string
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.
    copy_strategy str

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    snapshot_arn str
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.
    copyStrategy String

    Specifies the strategy used when copying data from the snapshot to the new volume.

    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume .

    snapshotArn String
    Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.

    VolumeRetentionPeriod, VolumeRetentionPeriodArgs

    Type string
    Defines 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.
    Value int
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100
    Type string
    Defines 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.
    Value int
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100
    type string
    Defines 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.
    value number
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100
    type String
    Defines 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.
    value Integer
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100
    type string
    Defines 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.
    value number
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100
    type str
    Defines 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.
    value int
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100
    type String
    Defines 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.
    value Number
    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

    • Seconds : 0 - 65,535
    • Minutes : 0 - 65,535
    • Hours : 0 - 24
    • Days : 0 - 365
    • Months : 0 - 12
    • Years : 0 - 100

    VolumeSnaplockConfiguration, VolumeSnaplockConfigurationArgs

    SnaplockType string
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    AuditLogVolume string

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    AutocommitPeriod Pulumi.AwsNative.FSx.Inputs.VolumeAutocommitPeriod
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    PrivilegedDelete string

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    RetentionPeriod Pulumi.AwsNative.FSx.Inputs.VolumeSnaplockRetentionPeriod
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    VolumeAppendModeEnabled string

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    SnaplockType string
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    AuditLogVolume string

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    AutocommitPeriod VolumeAutocommitPeriod
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    PrivilegedDelete string

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    RetentionPeriod VolumeSnaplockRetentionPeriod
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    VolumeAppendModeEnabled string

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    snaplock_type string
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    audit_log_volume string

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    autocommit_period object
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    privileged_delete string

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    retention_period object
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    volume_append_mode_enabled string

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    snaplockType String
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    auditLogVolume String

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    autocommitPeriod VolumeAutocommitPeriod
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    privilegedDelete String

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    retentionPeriod VolumeSnaplockRetentionPeriod
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    volumeAppendModeEnabled String

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    snaplockType string
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    auditLogVolume string

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    autocommitPeriod VolumeAutocommitPeriod
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    privilegedDelete string

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    retentionPeriod VolumeSnaplockRetentionPeriod
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    volumeAppendModeEnabled string

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    snaplock_type str
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    audit_log_volume str

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    autocommit_period VolumeAutocommitPeriod
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    privileged_delete str

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    retention_period VolumeSnaplockRetentionPeriod
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    volume_append_mode_enabled str

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    snaplockType String
    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

    • COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
    • ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .
    auditLogVolume String

    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

    For more information, see SnapLock audit log volumes .

    autocommitPeriod Property Map
    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
    privilegedDelete String

    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

    For more information, see Privileged delete .

    retentionPeriod Property Map
    Specifies the retention period of an FSx for ONTAP SnapLock volume.
    volumeAppendModeEnabled String

    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

    For more information, see Volume-append mode .

    VolumeSnaplockRetentionPeriod, VolumeSnaplockRetentionPeriodArgs

    DefaultRetention Pulumi.AwsNative.FSx.Inputs.VolumeRetentionPeriod
    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.
    MaximumRetention Pulumi.AwsNative.FSx.Inputs.VolumeRetentionPeriod
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    MinimumRetention Pulumi.AwsNative.FSx.Inputs.VolumeRetentionPeriod
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    DefaultRetention VolumeRetentionPeriod
    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.
    MaximumRetention VolumeRetentionPeriod
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    MinimumRetention VolumeRetentionPeriod
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    default_retention object
    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.
    maximum_retention object
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    minimum_retention object
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    defaultRetention VolumeRetentionPeriod
    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.
    maximumRetention VolumeRetentionPeriod
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    minimumRetention VolumeRetentionPeriod
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    defaultRetention VolumeRetentionPeriod
    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.
    maximumRetention VolumeRetentionPeriod
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    minimumRetention VolumeRetentionPeriod
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    default_retention VolumeRetentionPeriod
    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.
    maximum_retention VolumeRetentionPeriod
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    minimum_retention VolumeRetentionPeriod
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    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.
    maximumRetention Property Map
    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
    minimumRetention Property Map
    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

    VolumeTieringPolicy, VolumeTieringPolicyArgs

    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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    Name string
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    Name string
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    cooling_period 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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    name string
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    name String
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    name string
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    name str
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    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 the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .
    name String
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

    VolumeUserAndGroupQuotas, VolumeUserAndGroupQuotasArgs

    Id int
    The ID of the user or group that the quota applies to.
    StorageCapacityQuotaGiB int
    The user or group's storage quota, in gibibytes (GiB).
    Type string
    Specifies whether the quota applies to a user or group.
    Id int
    The ID of the user or group that the quota applies to.
    StorageCapacityQuotaGiB int
    The user or group's storage quota, in gibibytes (GiB).
    Type string
    Specifies whether the quota applies to a user or group.
    id number
    The ID of the user or group that the quota applies to.
    storage_capacity_quota_gi_b number
    The user or group's storage quota, in gibibytes (GiB).
    type string
    Specifies whether the quota applies to a user or group.
    id Integer
    The ID of the user or group that the quota applies to.
    storageCapacityQuotaGiB Integer
    The user or group's storage quota, in gibibytes (GiB).
    type String
    Specifies whether the quota applies to a user or group.
    id number
    The ID of the user or group that the quota applies to.
    storageCapacityQuotaGiB number
    The user or group's storage quota, in gibibytes (GiB).
    type string
    Specifies whether the quota applies to a user or group.
    id int
    The ID of the user or group that the quota applies to.
    storage_capacity_quota_gi_b int
    The user or group's storage quota, in gibibytes (GiB).
    type str
    Specifies whether the quota applies to a user or group.
    id Number
    The ID of the user or group that the quota applies to.
    storageCapacityQuotaGiB Number
    The user or group's storage quota, in gibibytes (GiB).
    type String
    Specifies whether the quota applies to a user or group.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.79.0
    published on Monday, Sep 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial