OpenZfsVolume class
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"])
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_fsx_openzfsvolume" "test" {
name = "testvolume"
parent_volume_id = 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.ArrayList;
import java.util.Arrays;
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}
Import
Using pulumi import, import FSx Volumes using the id. For example:
$ pulumi import aws:fsx/openZfsVolume:OpenZfsVolume example fsvol-543ab12b1ca672f33
Constructors
- OpenZfsVolume(String name, {OpenZfsVolumeArgs? args, CustomResourceOptions? options})
-
Creates a new OpenZfsVolume.
nameThe Pulumi resource name.argsArguments used to configure this OpenZfsVolume. The set of arguments for OpenZfsVolume.optionsResource options controlling this resource's behavior. - OpenZfsVolume.reference(String urn)
- Creates a typed reference to an existing OpenZfsVolume resource.
Properties
-
arn
↔ Output<
String> -
ARN of the file system.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
copyTagsToSnapshots
↔ Output<
bool?> -
Whether tags for the file system should be copied to snapshots. Default is false.
latefinal
-
dataCompressionType
↔ Output<
String?> -
Method used to compress the data on the volume. Valid values are
NONEorZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.latefinal -
deleteVolumeOptions
↔ Output<
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..latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
latefinal
-
nfsExports
↔ Output<
OpenZfsVolumeNfsExports?> -
NFS export configuration for the root volume. Exactly 1 item. See
nfsExportsBlock Below for details.latefinal -
originSnapshot
↔ Output<
OpenZfsVolumeOriginSnapshot?> -
Configuration to use when creating the OpenZFS volume. See
originSnapshotBlock below for details.latefinal -
parentVolumeId
↔ Output<
String> -
Volume ID of the volume that will be the parent volume for the volume being created, this could be the root volume created from the
aws.fsx.OpenZfsFileSystemresource with therootVolumeIdor theidproperty of anotheraws.fsx.OpenZfsVolume.latefinal -
readOnly
↔ Output<
bool> -
Whether the volume is read-only. Default is false.
latefinal
-
recordSizeKib
↔ Output<
int?> -
Record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4,8,16,32,64,128,256,512, or1024KiB. Default is128KiB.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storageCapacityQuotaGib
↔ Output<
int> -
Maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
latefinal
-
storageCapacityReservationGib
↔ Output<
int> -
Amount of storage in gibibytes (GiB) to reserve from the parent volume.
latefinal
-
Map of tags to assign to the file system. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userAndGroupQuotas
↔ Output<
List< OpenZfsVolumeUserAndGroupQuota> > -
Specify how much storage users or groups can use on the volume. Maximum number of items defined by FSx for OpenZFS Resource quota. See
userAndGroupQuotasBlock Below.latefinal -
volumeType
↔ Output<
String?> -
Volume type. Default is
OPENZFS.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {OpenZfsVolumeState? state, CustomResourceOptions? options}) → OpenZfsVolume -
Gets an existing OpenZfsVolume resource's state with the given
nameandid.