1. Packages
  2. AWS Classic
  3. API Docs
  4. fsx
  5. OpenZfsVolume

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.28.1 published on Thursday, Mar 28, 2024 by Pulumi

aws.fsx.OpenZfsVolume

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.28.1 published on Thursday, Mar 28, 2024 by Pulumi

    Manages an Amazon FSx for OpenZFS volume. See the FSx OpenZFS User Guide for more information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.fsx.OpenZfsVolume("test", {
        name: "testvolume",
        parentVolumeId: testAwsFsxOpenzfsFileSystem.rootVolumeId,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.fsx.OpenZfsVolume("test",
        name="testvolume",
        parent_volume_id=test_aws_fsx_openzfs_file_system["rootVolumeId"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fsx.NewOpenZfsVolume(ctx, "test", &fsx.OpenZfsVolumeArgs{
    			Name:           pulumi.String("testvolume"),
    			ParentVolumeId: pulumi.Any(testAwsFsxOpenzfsFileSystem.RootVolumeId),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.Fsx.OpenZfsVolume("test", new()
        {
            Name = "testvolume",
            ParentVolumeId = testAwsFsxOpenzfsFileSystem.RootVolumeId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.fsx.OpenZfsVolume;
    import com.pulumi.aws.fsx.OpenZfsVolumeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new OpenZfsVolume("test", OpenZfsVolumeArgs.builder()        
                .name("testvolume")
                .parentVolumeId(testAwsFsxOpenzfsFileSystem.rootVolumeId())
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:fsx:OpenZfsVolume
        properties:
          name: testvolume
          parentVolumeId: ${testAwsFsxOpenzfsFileSystem.rootVolumeId}
    

    Create OpenZfsVolume Resource

    new OpenZfsVolume(name: string, args: OpenZfsVolumeArgs, opts?: CustomResourceOptions);
    @overload
    def OpenZfsVolume(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      copy_tags_to_snapshots: Optional[bool] = None,
                      data_compression_type: Optional[str] = None,
                      delete_volume_options: Optional[str] = None,
                      name: Optional[str] = None,
                      nfs_exports: Optional[OpenZfsVolumeNfsExportsArgs] = None,
                      origin_snapshot: Optional[OpenZfsVolumeOriginSnapshotArgs] = None,
                      parent_volume_id: Optional[str] = None,
                      read_only: Optional[bool] = None,
                      record_size_kib: Optional[int] = None,
                      storage_capacity_quota_gib: Optional[int] = None,
                      storage_capacity_reservation_gib: Optional[int] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      user_and_group_quotas: Optional[Sequence[OpenZfsVolumeUserAndGroupQuotaArgs]] = None,
                      volume_type: Optional[str] = None)
    @overload
    def OpenZfsVolume(resource_name: str,
                      args: OpenZfsVolumeArgs,
                      opts: Optional[ResourceOptions] = None)
    func NewOpenZfsVolume(ctx *Context, name string, args OpenZfsVolumeArgs, opts ...ResourceOption) (*OpenZfsVolume, error)
    public OpenZfsVolume(string name, OpenZfsVolumeArgs args, CustomResourceOptions? opts = null)
    public OpenZfsVolume(String name, OpenZfsVolumeArgs args)
    public OpenZfsVolume(String name, OpenZfsVolumeArgs args, CustomResourceOptions options)
    
    type: aws:fsx:OpenZfsVolume
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args OpenZfsVolumeArgs
    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 OpenZfsVolumeArgs
    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 OpenZfsVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpenZfsVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpenZfsVolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OpenZfsVolume Resource Properties

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

    Inputs

    The OpenZfsVolume resource accepts the following input properties:

    ParentVolumeId string
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    CopyTagsToSnapshots bool
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    DataCompressionType string
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    DeleteVolumeOptions string
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    Name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    NfsExports Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    OriginSnapshot Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeOriginSnapshot
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    ReadOnly bool
    specifies whether the volume is read-only. Default is false.
    RecordSizeKib int
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    StorageCapacityQuotaGib int
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    StorageCapacityReservationGib int
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    Tags Dictionary<string, string>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    UserAndGroupQuotas List<Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeUserAndGroupQuota>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    VolumeType string
    ParentVolumeId string
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    CopyTagsToSnapshots bool
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    DataCompressionType string
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    DeleteVolumeOptions string
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    Name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    NfsExports OpenZfsVolumeNfsExportsArgs
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    OriginSnapshot OpenZfsVolumeOriginSnapshotArgs
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    ReadOnly bool
    specifies whether the volume is read-only. Default is false.
    RecordSizeKib int
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    StorageCapacityQuotaGib int
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    StorageCapacityReservationGib int
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    Tags map[string]string
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    UserAndGroupQuotas []OpenZfsVolumeUserAndGroupQuotaArgs
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    VolumeType string
    parentVolumeId String
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    copyTagsToSnapshots Boolean
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    dataCompressionType String
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    deleteVolumeOptions String
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfsExports OpenZfsVolumeNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    originSnapshot OpenZfsVolumeOriginSnapshot
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    readOnly Boolean
    specifies whether the volume is read-only. Default is false.
    recordSizeKib Integer
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storageCapacityQuotaGib Integer
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storageCapacityReservationGib Integer
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags Map<String,String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userAndGroupQuotas List<OpenZfsVolumeUserAndGroupQuota>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volumeType String
    parentVolumeId string
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    copyTagsToSnapshots boolean
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    dataCompressionType string
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    deleteVolumeOptions string
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfsExports OpenZfsVolumeNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    originSnapshot OpenZfsVolumeOriginSnapshot
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    readOnly boolean
    specifies whether the volume is read-only. Default is false.
    recordSizeKib number
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storageCapacityQuotaGib number
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storageCapacityReservationGib number
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags {[key: string]: string}
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userAndGroupQuotas OpenZfsVolumeUserAndGroupQuota[]
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volumeType string
    parent_volume_id str
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    copy_tags_to_snapshots bool
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    data_compression_type str
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    delete_volume_options str
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name str
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfs_exports OpenZfsVolumeNfsExportsArgs
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    origin_snapshot OpenZfsVolumeOriginSnapshotArgs
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    read_only bool
    specifies whether the volume is read-only. Default is false.
    record_size_kib int
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storage_capacity_quota_gib int
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storage_capacity_reservation_gib int
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags Mapping[str, str]
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    user_and_group_quotas Sequence[OpenZfsVolumeUserAndGroupQuotaArgs]
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volume_type str
    parentVolumeId String
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    copyTagsToSnapshots Boolean
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    dataCompressionType String
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    deleteVolumeOptions String
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfsExports Property Map
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    originSnapshot Property Map
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    readOnly Boolean
    specifies whether the volume is read-only. Default is false.
    recordSizeKib Number
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storageCapacityQuotaGib Number
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storageCapacityReservationGib Number
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags Map<String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userAndGroupQuotas List<Property Map>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volumeType String

    Outputs

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

    Arn string
    Amazon Resource Name of the file system.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    Arn string
    Amazon Resource Name of the file system.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn String
    Amazon Resource Name of the file system.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn string
    Amazon Resource Name of the file system.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn str
    Amazon Resource Name of the file system.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn String
    Amazon Resource Name of the file system.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    Look up Existing OpenZfsVolume Resource

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

    public static get(name: string, id: Input<ID>, state?: OpenZfsVolumeState, opts?: CustomResourceOptions): OpenZfsVolume
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            copy_tags_to_snapshots: Optional[bool] = None,
            data_compression_type: Optional[str] = None,
            delete_volume_options: Optional[str] = None,
            name: Optional[str] = None,
            nfs_exports: Optional[OpenZfsVolumeNfsExportsArgs] = None,
            origin_snapshot: Optional[OpenZfsVolumeOriginSnapshotArgs] = None,
            parent_volume_id: Optional[str] = None,
            read_only: Optional[bool] = None,
            record_size_kib: Optional[int] = None,
            storage_capacity_quota_gib: Optional[int] = None,
            storage_capacity_reservation_gib: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            user_and_group_quotas: Optional[Sequence[OpenZfsVolumeUserAndGroupQuotaArgs]] = None,
            volume_type: Optional[str] = None) -> OpenZfsVolume
    func GetOpenZfsVolume(ctx *Context, name string, id IDInput, state *OpenZfsVolumeState, opts ...ResourceOption) (*OpenZfsVolume, error)
    public static OpenZfsVolume Get(string name, Input<string> id, OpenZfsVolumeState? state, CustomResourceOptions? opts = null)
    public static OpenZfsVolume get(String name, Output<String> id, OpenZfsVolumeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name of the file system.
    CopyTagsToSnapshots bool
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    DataCompressionType string
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    DeleteVolumeOptions string
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    Name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    NfsExports Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    OriginSnapshot Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeOriginSnapshot
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    ParentVolumeId string
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    ReadOnly bool
    specifies whether the volume is read-only. Default is false.
    RecordSizeKib int
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    StorageCapacityQuotaGib int
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    StorageCapacityReservationGib int
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    Tags Dictionary<string, string>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    UserAndGroupQuotas List<Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeUserAndGroupQuota>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    VolumeType string
    Arn string
    Amazon Resource Name of the file system.
    CopyTagsToSnapshots bool
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    DataCompressionType string
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    DeleteVolumeOptions string
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    Name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    NfsExports OpenZfsVolumeNfsExportsArgs
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    OriginSnapshot OpenZfsVolumeOriginSnapshotArgs
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    ParentVolumeId string
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    ReadOnly bool
    specifies whether the volume is read-only. Default is false.
    RecordSizeKib int
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    StorageCapacityQuotaGib int
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    StorageCapacityReservationGib int
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    Tags map[string]string
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    UserAndGroupQuotas []OpenZfsVolumeUserAndGroupQuotaArgs
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    VolumeType string
    arn String
    Amazon Resource Name of the file system.
    copyTagsToSnapshots Boolean
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    dataCompressionType String
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    deleteVolumeOptions String
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfsExports OpenZfsVolumeNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    originSnapshot OpenZfsVolumeOriginSnapshot
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    parentVolumeId String
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    readOnly Boolean
    specifies whether the volume is read-only. Default is false.
    recordSizeKib Integer
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storageCapacityQuotaGib Integer
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storageCapacityReservationGib Integer
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags Map<String,String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    userAndGroupQuotas List<OpenZfsVolumeUserAndGroupQuota>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volumeType String
    arn string
    Amazon Resource Name of the file system.
    copyTagsToSnapshots boolean
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    dataCompressionType string
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    deleteVolumeOptions string
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfsExports OpenZfsVolumeNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    originSnapshot OpenZfsVolumeOriginSnapshot
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    parentVolumeId string
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    readOnly boolean
    specifies whether the volume is read-only. Default is false.
    recordSizeKib number
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storageCapacityQuotaGib number
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storageCapacityReservationGib number
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags {[key: string]: string}
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    userAndGroupQuotas OpenZfsVolumeUserAndGroupQuota[]
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volumeType string
    arn str
    Amazon Resource Name of the file system.
    copy_tags_to_snapshots bool
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    data_compression_type str
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    delete_volume_options str
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name str
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfs_exports OpenZfsVolumeNfsExportsArgs
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    origin_snapshot OpenZfsVolumeOriginSnapshotArgs
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    parent_volume_id str
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    read_only bool
    specifies whether the volume is read-only. Default is false.
    record_size_kib int
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storage_capacity_quota_gib int
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storage_capacity_reservation_gib int
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags Mapping[str, str]
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    user_and_group_quotas Sequence[OpenZfsVolumeUserAndGroupQuotaArgs]
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volume_type str
    arn String
    Amazon Resource Name of the file system.
    copyTagsToSnapshots Boolean
    A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
    dataCompressionType String
    Method used to compress the data on the volume. Valid values are NONE or ZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
    deleteVolumeOptions String
    Whether to delete all child volumes and snapshots. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..
    name String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    nfsExports Property Map
    NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block Below for details.
    originSnapshot Property Map
    Specifies the configuration to use when creating the OpenZFS volume. See origin_snapshot Block below for details.
    parentVolumeId String
    The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the aws.fsx.OpenZfsFileSystem resource with the root_volume_id or the id property of another aws.fsx.OpenZfsVolume.
    readOnly Boolean
    specifies whether the volume is read-only. Default is false.
    recordSizeKib Number
    The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
    storageCapacityQuotaGib Number
    The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
    storageCapacityReservationGib Number
    The amount of storage in gibibytes (GiB) to reserve from the parent volume.
    tags Map<String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    userAndGroupQuotas List<Property Map>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block Below.
    volumeType String

    Supporting Types

    OpenZfsVolumeNfsExports, OpenZfsVolumeNfsExportsArgs

    ClientConfigurations List<Pulumi.Aws.Fsx.Inputs.OpenZfsVolumeNfsExportsClientConfiguration>
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See client_configurations Block below for details.
    ClientConfigurations []OpenZfsVolumeNfsExportsClientConfiguration
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See client_configurations Block below for details.
    clientConfigurations List<OpenZfsVolumeNfsExportsClientConfiguration>
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See client_configurations Block below for details.
    clientConfigurations OpenZfsVolumeNfsExportsClientConfiguration[]
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See client_configurations Block below for details.
    client_configurations Sequence[OpenZfsVolumeNfsExportsClientConfiguration]
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See client_configurations Block below for details.
    clientConfigurations List<Property Map>
    A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See client_configurations Block below for details.

    OpenZfsVolumeNfsExportsClientConfiguration, OpenZfsVolumeNfsExportsClientConfigurationArgs

    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. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.
    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. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.
    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. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.
    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. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.
    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. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.
    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. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.

    OpenZfsVolumeOriginSnapshot, OpenZfsVolumeOriginSnapshotArgs

    CopyStrategy string
    Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are CLONE, FULL_COPY, INCREMENTAL_COPY.
    SnapshotArn string
    The Amazon Resource Name (ARN) of the origin snapshot.
    CopyStrategy string
    Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are CLONE, FULL_COPY, INCREMENTAL_COPY.
    SnapshotArn string
    The Amazon Resource Name (ARN) of the origin snapshot.
    copyStrategy String
    Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are CLONE, FULL_COPY, INCREMENTAL_COPY.
    snapshotArn String
    The Amazon Resource Name (ARN) of the origin snapshot.
    copyStrategy string
    Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are CLONE, FULL_COPY, INCREMENTAL_COPY.
    snapshotArn string
    The Amazon Resource Name (ARN) of the origin snapshot.
    copy_strategy str
    Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are CLONE, FULL_COPY, INCREMENTAL_COPY.
    snapshot_arn str
    The Amazon Resource Name (ARN) of the origin snapshot.
    copyStrategy String
    Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are CLONE, FULL_COPY, INCREMENTAL_COPY.
    snapshotArn String
    The Amazon Resource Name (ARN) of the origin snapshot.

    OpenZfsVolumeUserAndGroupQuota, OpenZfsVolumeUserAndGroupQuotaArgs

    Id int
    The ID of the user or group. Valid values between 0 and 2147483647
    StorageCapacityQuotaGib int
    The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
    Type string
    Id int
    The ID of the user or group. Valid values between 0 and 2147483647
    StorageCapacityQuotaGib int
    The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
    Type string
    id Integer
    The ID of the user or group. Valid values between 0 and 2147483647
    storageCapacityQuotaGib Integer
    The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
    type String
    id number
    The ID of the user or group. Valid values between 0 and 2147483647
    storageCapacityQuotaGib number
    The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
    type string
    id int
    The ID of the user or group. Valid values between 0 and 2147483647
    storage_capacity_quota_gib int
    The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
    type str
    id Number
    The ID of the user or group. Valid values between 0 and 2147483647
    storageCapacityQuotaGib Number
    The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
    type String

    Import

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

    $ pulumi import aws:fsx/openZfsVolume:OpenZfsVolume example fsvol-543ab12b1ca672f33
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.28.1 published on Thursday, Mar 28, 2024 by Pulumi