aws.fsx.OpenZfsVolume
Explore with Pulumi AI
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OpenZfsVolume(name: string, args: OpenZfsVolumeArgs, opts?: CustomResourceOptions);
@overload
def OpenZfsVolume(resource_name: str,
args: OpenZfsVolumeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OpenZfsVolume(resource_name: str,
opts: Optional[ResourceOptions] = None,
parent_volume_id: Optional[str] = None,
name: Optional[str] = None,
delete_volume_options: Optional[str] = None,
copy_tags_to_snapshots: Optional[bool] = None,
nfs_exports: Optional[OpenZfsVolumeNfsExportsArgs] = None,
origin_snapshot: Optional[OpenZfsVolumeOriginSnapshotArgs] = None,
data_compression_type: 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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var openZfsVolumeResource = new Aws.Fsx.OpenZfsVolume("openZfsVolumeResource", new()
{
ParentVolumeId = "string",
Name = "string",
DeleteVolumeOptions = "string",
CopyTagsToSnapshots = false,
NfsExports = new Aws.Fsx.Inputs.OpenZfsVolumeNfsExportsArgs
{
ClientConfigurations = new[]
{
new Aws.Fsx.Inputs.OpenZfsVolumeNfsExportsClientConfigurationArgs
{
Clients = "string",
Options = new[]
{
"string",
},
},
},
},
OriginSnapshot = new Aws.Fsx.Inputs.OpenZfsVolumeOriginSnapshotArgs
{
CopyStrategy = "string",
SnapshotArn = "string",
},
DataCompressionType = "string",
ReadOnly = false,
RecordSizeKib = 0,
StorageCapacityQuotaGib = 0,
StorageCapacityReservationGib = 0,
Tags =
{
{ "string", "string" },
},
UserAndGroupQuotas = new[]
{
new Aws.Fsx.Inputs.OpenZfsVolumeUserAndGroupQuotaArgs
{
Id = 0,
StorageCapacityQuotaGib = 0,
Type = "string",
},
},
VolumeType = "string",
});
example, err := fsx.NewOpenZfsVolume(ctx, "openZfsVolumeResource", &fsx.OpenZfsVolumeArgs{
ParentVolumeId: pulumi.String("string"),
Name: pulumi.String("string"),
DeleteVolumeOptions: pulumi.String("string"),
CopyTagsToSnapshots: pulumi.Bool(false),
NfsExports: &fsx.OpenZfsVolumeNfsExportsArgs{
ClientConfigurations: fsx.OpenZfsVolumeNfsExportsClientConfigurationArray{
&fsx.OpenZfsVolumeNfsExportsClientConfigurationArgs{
Clients: pulumi.String("string"),
Options: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
OriginSnapshot: &fsx.OpenZfsVolumeOriginSnapshotArgs{
CopyStrategy: pulumi.String("string"),
SnapshotArn: pulumi.String("string"),
},
DataCompressionType: pulumi.String("string"),
ReadOnly: pulumi.Bool(false),
RecordSizeKib: pulumi.Int(0),
StorageCapacityQuotaGib: pulumi.Int(0),
StorageCapacityReservationGib: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserAndGroupQuotas: fsx.OpenZfsVolumeUserAndGroupQuotaArray{
&fsx.OpenZfsVolumeUserAndGroupQuotaArgs{
Id: pulumi.Int(0),
StorageCapacityQuotaGib: pulumi.Int(0),
Type: pulumi.String("string"),
},
},
VolumeType: pulumi.String("string"),
})
var openZfsVolumeResource = new OpenZfsVolume("openZfsVolumeResource", OpenZfsVolumeArgs.builder()
.parentVolumeId("string")
.name("string")
.deleteVolumeOptions("string")
.copyTagsToSnapshots(false)
.nfsExports(OpenZfsVolumeNfsExportsArgs.builder()
.clientConfigurations(OpenZfsVolumeNfsExportsClientConfigurationArgs.builder()
.clients("string")
.options("string")
.build())
.build())
.originSnapshot(OpenZfsVolumeOriginSnapshotArgs.builder()
.copyStrategy("string")
.snapshotArn("string")
.build())
.dataCompressionType("string")
.readOnly(false)
.recordSizeKib(0)
.storageCapacityQuotaGib(0)
.storageCapacityReservationGib(0)
.tags(Map.of("string", "string"))
.userAndGroupQuotas(OpenZfsVolumeUserAndGroupQuotaArgs.builder()
.id(0)
.storageCapacityQuotaGib(0)
.type("string")
.build())
.volumeType("string")
.build());
open_zfs_volume_resource = aws.fsx.OpenZfsVolume("openZfsVolumeResource",
parent_volume_id="string",
name="string",
delete_volume_options="string",
copy_tags_to_snapshots=False,
nfs_exports={
"client_configurations": [{
"clients": "string",
"options": ["string"],
}],
},
origin_snapshot={
"copy_strategy": "string",
"snapshot_arn": "string",
},
data_compression_type="string",
read_only=False,
record_size_kib=0,
storage_capacity_quota_gib=0,
storage_capacity_reservation_gib=0,
tags={
"string": "string",
},
user_and_group_quotas=[{
"id": 0,
"storage_capacity_quota_gib": 0,
"type": "string",
}],
volume_type="string")
const openZfsVolumeResource = new aws.fsx.OpenZfsVolume("openZfsVolumeResource", {
parentVolumeId: "string",
name: "string",
deleteVolumeOptions: "string",
copyTagsToSnapshots: false,
nfsExports: {
clientConfigurations: [{
clients: "string",
options: ["string"],
}],
},
originSnapshot: {
copyStrategy: "string",
snapshotArn: "string",
},
dataCompressionType: "string",
readOnly: false,
recordSizeKib: 0,
storageCapacityQuotaGib: 0,
storageCapacityReservationGib: 0,
tags: {
string: "string",
},
userAndGroupQuotas: [{
id: 0,
storageCapacityQuotaGib: 0,
type: "string",
}],
volumeType: "string",
});
type: aws:fsx:OpenZfsVolume
properties:
copyTagsToSnapshots: false
dataCompressionType: string
deleteVolumeOptions: string
name: string
nfsExports:
clientConfigurations:
- clients: string
options:
- string
originSnapshot:
copyStrategy: string
snapshotArn: string
parentVolumeId: string
readOnly: false
recordSizeKib: 0
storageCapacityQuotaGib: 0
storageCapacityReservationGib: 0
tags:
string: string
userAndGroupQuotas:
- id: 0
storageCapacityQuotaGib: 0
type: string
volumeType: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OpenZfsVolume resource accepts the following input properties:
- Parent
Volume stringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - bool
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- Data
Compression stringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 stringOptions - 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.
- Nfs
Exports OpenZfs Volume Nfs Exports - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - Origin
Snapshot OpenZfs Volume Origin Snapshot - 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 intKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - Storage
Capacity intQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- Storage
Capacity intReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - User
And List<OpenGroup Quotas Zfs Volume User And Group Quota> - 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 string
- Parent
Volume stringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - bool
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- Data
Compression stringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 stringOptions - 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.
- Nfs
Exports OpenZfs Volume Nfs Exports Args - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - Origin
Snapshot OpenZfs Volume Origin Snapshot Args - 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 intKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - Storage
Capacity intQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- Storage
Capacity intReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - User
And []OpenGroup Quotas Zfs Volume User And Group Quota Args - 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 string
- parent
Volume StringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - Boolean
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data
Compression StringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 StringOptions - 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.
- nfs
Exports OpenZfs Volume Nfs Exports - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin
Snapshot OpenZfs Volume Origin Snapshot - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - read
Only Boolean - specifies whether the volume is read-only. Default is false.
- record
Size IntegerKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage
Capacity IntegerQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage
Capacity IntegerReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - user
And List<OpenGroup Quotas Zfs Volume User And Group Quota> - 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 String
- parent
Volume stringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - boolean
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data
Compression stringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 stringOptions - 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.
- nfs
Exports OpenZfs Volume Nfs Exports - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin
Snapshot OpenZfs Volume Origin Snapshot - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - read
Only boolean - specifies whether the volume is read-only. Default is false.
- record
Size numberKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage
Capacity numberQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage
Capacity numberReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- {[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. - user
And OpenGroup Quotas Zfs Volume User And Group Quota[] - 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 string
- parent_
volume_ strid - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - bool
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data_
compression_ strtype - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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_ stroptions - 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 OpenZfs Volume Nfs Exports Args - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin_
snapshot OpenZfs Volume Origin Snapshot Args - 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_ intkib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage_
capacity_ intquota_ gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage_
capacity_ intreservation_ gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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_ Sequence[Opengroup_ quotas Zfs Volume User And Group Quota Args] - 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
- parent
Volume StringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - Boolean
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data
Compression StringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 StringOptions - 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.
- nfs
Exports Property Map - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin
Snapshot Property Map - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - read
Only Boolean - specifies whether the volume is read-only. Default is false.
- record
Size NumberKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage
Capacity NumberQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage
Capacity NumberReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - user
And List<Property Map>Group Quotas - 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 String
Outputs
All input properties are implicitly available as output properties. Additionally, the OpenZfsVolume resource produces the following output properties:
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.
- Arn string
- Amazon Resource Name of the file system.
- bool
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- Data
Compression stringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 stringOptions - 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.
- Nfs
Exports OpenZfs Volume Nfs Exports - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - Origin
Snapshot OpenZfs Volume Origin Snapshot - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - Parent
Volume stringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - Read
Only bool - specifies whether the volume is read-only. Default is false.
- Record
Size intKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - Storage
Capacity intQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- Storage
Capacity intReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - User
And List<OpenGroup Quotas Zfs Volume User And Group Quota> - 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 string
- Arn string
- Amazon Resource Name of the file system.
- bool
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- Data
Compression stringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 stringOptions - 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.
- Nfs
Exports OpenZfs Volume Nfs Exports Args - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - Origin
Snapshot OpenZfs Volume Origin Snapshot Args - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - Parent
Volume stringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - Read
Only bool - specifies whether the volume is read-only. Default is false.
- Record
Size intKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - Storage
Capacity intQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- Storage
Capacity intReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - User
And []OpenGroup Quotas Zfs Volume User And Group Quota Args - 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 string
- arn String
- Amazon Resource Name of the file system.
- Boolean
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data
Compression StringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 StringOptions - 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.
- nfs
Exports OpenZfs Volume Nfs Exports - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin
Snapshot OpenZfs Volume Origin Snapshot - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - parent
Volume StringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - read
Only Boolean - specifies whether the volume is read-only. Default is false.
- record
Size IntegerKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage
Capacity IntegerQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage
Capacity IntegerReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
And List<OpenGroup Quotas Zfs Volume User And Group Quota> - 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 String
- arn string
- Amazon Resource Name of the file system.
- boolean
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data
Compression stringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 stringOptions - 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.
- nfs
Exports OpenZfs Volume Nfs Exports - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin
Snapshot OpenZfs Volume Origin Snapshot - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - parent
Volume stringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - read
Only boolean - specifies whether the volume is read-only. Default is false.
- record
Size numberKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage
Capacity numberQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage
Capacity numberReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
And OpenGroup Quotas Zfs Volume User And Group Quota[] - 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 string
- arn str
- Amazon Resource Name of the file system.
- bool
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data_
compression_ strtype - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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_ stroptions - 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 OpenZfs Volume Nfs Exports Args - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin_
snapshot OpenZfs Volume Origin Snapshot Args - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - parent_
volume_ strid - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - read_
only bool - specifies whether the volume is read-only. Default is false.
- record_
size_ intkib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage_
capacity_ intquota_ gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage_
capacity_ intreservation_ gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user_
and_ Sequence[Opengroup_ quotas Zfs Volume User And Group Quota Args] - 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.
- Boolean
- A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
- data
Compression StringType - Method used to compress the data on the volume. Valid values are
NONE
orZSTD
. 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 StringOptions - 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.
- nfs
Exports Property Map - NFS export configuration for the root volume. Exactly 1 item. See
nfs_exports
Block Below for details. - origin
Snapshot Property Map - Specifies the configuration to use when creating the OpenZFS volume. See
origin_snapshot
Block below for details. - parent
Volume StringId - 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 theroot_volume_id
or theid
property of anotheraws.fsx.OpenZfsVolume
. - read
Only Boolean - specifies whether the volume is read-only. Default is false.
- record
Size NumberKib - The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4
,8
,16
,32
,64
,128
,256
,512
, or1024
KiB. The default is128
KiB. - storage
Capacity NumberQuota Gib - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
- storage
Capacity NumberReservation Gib - The amount of storage in gibibytes (GiB) to reserve from the parent volume.
- 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
And List<Property Map>Group Quotas - 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 String
Supporting Types
OpenZfsVolumeNfsExports, OpenZfsVolumeNfsExportsArgs
- Client
Configurations List<OpenZfs Volume Nfs Exports Client Configuration> - 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 []OpenZfs Volume Nfs Exports Client Configuration - 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 List<OpenZfs Volume Nfs Exports Client Configuration> - 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 OpenZfs Volume Nfs Exports Client Configuration[] - 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[OpenZfs Volume Nfs Exports Client Configuration] - 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 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
andsync
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
andsync
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
andsync
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
andsync
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
andsync
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
andsync
are used by default.
OpenZfsVolumeOriginSnapshot, OpenZfsVolumeOriginSnapshotArgs
- Copy
Strategy string - Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are
CLONE
,FULL_COPY
,INCREMENTAL_COPY
. - Snapshot
Arn string - The Amazon Resource Name (ARN) of the origin snapshot.
- Copy
Strategy string - Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are
CLONE
,FULL_COPY
,INCREMENTAL_COPY
. - Snapshot
Arn string - The Amazon Resource Name (ARN) of the origin snapshot.
- copy
Strategy String - Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are
CLONE
,FULL_COPY
,INCREMENTAL_COPY
. - snapshot
Arn String - The Amazon Resource Name (ARN) of the origin snapshot.
- copy
Strategy string - Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are
CLONE
,FULL_COPY
,INCREMENTAL_COPY
. - snapshot
Arn 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.
- copy
Strategy String - Specifies the strategy used when copying data from the snapshot to the new volume. Valid values are
CLONE
,FULL_COPY
,INCREMENTAL_COPY
. - snapshot
Arn 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
and2147483647
- Storage
Capacity intQuota Gib - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between
0
and2147483647
Type
- (Required) - A value that specifies whether the quota applies to a user or group. Valid values areUSER
orGROUP
.
- Type string
- Id int
- The ID of the user or group. Valid values between
0
and2147483647
- Storage
Capacity intQuota Gib - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between
0
and2147483647
Type
- (Required) - A value that specifies whether the quota applies to a user or group. Valid values areUSER
orGROUP
.
- Type string
- id Integer
- The ID of the user or group. Valid values between
0
and2147483647
- storage
Capacity IntegerQuota Gib - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between
0
and2147483647
Type
- (Required) - A value that specifies whether the quota applies to a user or group. Valid values areUSER
orGROUP
.
- type String
- id number
- The ID of the user or group. Valid values between
0
and2147483647
- storage
Capacity numberQuota Gib - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between
0
and2147483647
Type
- (Required) - A value that specifies whether the quota applies to a user or group. Valid values areUSER
orGROUP
.
- type string
- id int
- The ID of the user or group. Valid values between
0
and2147483647
- storage_
capacity_ intquota_ gib - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between
0
and2147483647
Type
- (Required) - A value that specifies whether the quota applies to a user or group. Valid values areUSER
orGROUP
.
- type str
- id Number
- The ID of the user or group. Valid values between
0
and2147483647
- storage
Capacity NumberQuota Gib - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between
0
and2147483647
Type
- (Required) - A value that specifies whether the quota applies to a user or group. Valid values areUSER
orGROUP
.
- type String
Import
Using pulumi import
, import FSx Volumes using the id
. For example:
$ pulumi import aws:fsx/openZfsVolume:OpenZfsVolume example fsvol-543ab12b1ca672f33
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.