OpenZfsFileSystem class

Manages an Amazon FSx for OpenZFS file system. 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.OpenZfsFileSystem("test", {
    storageCapacity: 64,
    subnetIds: [test1.id],
    deploymentType: "SINGLE_AZ_1",
    throughputCapacity: 64,
});
import pulumi
import pulumi_aws as aws

test = aws.fsx.OpenZfsFileSystem("test",
    storage_capacity=64,
    subnet_ids=[test1["id"]],
    deployment_type="SINGLE_AZ_1",
    throughput_capacity=64)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Fsx.OpenZfsFileSystem("test", new()
    {
        StorageCapacity = 64,
        SubnetIds = new[]
        {
            test1.Id,
        },
        DeploymentType = "SINGLE_AZ_1",
        ThroughputCapacity = 64,
    });

});
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.NewOpenZfsFileSystem(ctx, "test", &fsx.OpenZfsFileSystemArgs{
			StorageCapacity: pulumi.Int(64),
			SubnetIds: pulumi.StringArray{
				test1.Id,
			},
			DeploymentType:     pulumi.String("SINGLE_AZ_1"),
			ThroughputCapacity: pulumi.Int(64),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_fsx_openzfsfilesystem" "test" {
  storage_capacity    = 64
  subnet_ids          = [test1.id]
  deployment_type     = "SINGLE_AZ_1"
  throughput_capacity = 64
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OpenZfsFileSystem;
import com.pulumi.aws.fsx.OpenZfsFileSystemArgs;
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 OpenZfsFileSystem("test", OpenZfsFileSystemArgs.builder()
            .storageCapacity(64)
            .subnetIds(test1.id())
            .deploymentType("SINGLE_AZ_1")
            .throughputCapacity(64)
            .build());

    }
}
resources:
  test:
    type: aws:fsx:OpenZfsFileSystem
    properties:
      storageCapacity: 64
      subnetIds:
        - ${test1.id}
      deploymentType: SINGLE_AZ_1
      throughputCapacity: 64

Import

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

$ pulumi import aws:fsx/openZfsFileSystem:OpenZfsFileSystem example fs-543ab12b1ca672f33

Certain resource arguments, like securityGroupIds, do not have a FSx API method for reading the information after creation. If the argument is set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignoreChanges to hide the difference. For example:

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

const example = new aws.fsx.OpenZfsFileSystem("example", {securityGroupIds: [exampleAwsSecurityGroup.id]}, {
    ignoreChanges: ["securityGroupIds"],
});
import pulumi
import pulumi_aws as aws

example = aws.fsx.OpenZfsFileSystem("example", security_group_ids=[example_aws_security_group["id"]],
opts = pulumi.ResourceOptions(ignore_changes=["securityGroupIds"]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Fsx.OpenZfsFileSystem("example", new()
    {
        SecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
    }, new CustomResourceOptions
    {
        IgnoreChanges =
        {
            "securityGroupIds",
        },
    });

});
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.NewOpenZfsFileSystem(ctx, "example", &fsx.OpenZfsFileSystemArgs{
			SecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
		}, pulumi.IgnoreChanges([]string{
			"securityGroupIds",
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_fsx_openzfsfilesystem" "example" {
  lifecycle {
    ignore_changes = [securityGroupIds]
  }
  security_group_ids = [exampleAwsSecurityGroup.id]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OpenZfsFileSystem;
import com.pulumi.aws.fsx.OpenZfsFileSystemArgs;
import com.pulumi.resources.CustomResourceOptions;
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 example = new OpenZfsFileSystem("example", OpenZfsFileSystemArgs.builder()
            .securityGroupIds(exampleAwsSecurityGroup.id())
            .build(), CustomResourceOptions.builder()
                .ignoreChanges("securityGroupIds")
                .build());

    }
}
resources:
  example:
    type: aws:fsx:OpenZfsFileSystem
    properties:
      securityGroupIds:
        - ${exampleAwsSecurityGroup.id}
    options:
      ignoreChanges:
        - securityGroupIds

Constructors

OpenZfsFileSystem(String name, {OpenZfsFileSystemArgs? args, CustomResourceOptions? options})
Creates a new OpenZfsFileSystem. name The Pulumi resource name. args Arguments used to configure this OpenZfsFileSystem. The set of arguments for OpenZfsFileSystem. options Resource options controlling this resource's behavior.
OpenZfsFileSystem.reference(String urn)
Creates a typed reference to an existing OpenZfsFileSystem resource.

Properties

arn ↔ Output<String>
ARN of the file system.
latefinal
automaticBackupRetentionDays ↔ Output<int?>
Number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
latefinal
backupId ↔ Output<String?>
ID of the source backup to create the filesystem from.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
copyTagsToBackups ↔ Output<bool?>
Whether tags for the file system should be copied to backups. Default value is false.
latefinal
copyTagsToVolumes ↔ Output<bool?>
Whether tags for the file system should be copied to snapshots. Default value is false.
latefinal
dailyAutomaticBackupStartTime ↔ Output<String>
Recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automaticBackupRetentionDays to be set.
latefinal
deleteOptions ↔ Output<List<String>?>
List of delete options, which at present supports only one value that specifies whether to delete all child volumes and snapshots when the file system is deleted. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.
latefinal
deploymentType ↔ Output<String>
Filesystem deployment type. See the AWS API documentation for a list of valid values.
latefinal
diskIopsConfiguration ↔ Output<OpenZfsFileSystemDiskIopsConfiguration>
SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See diskIopsConfiguration Block for details.
latefinal
dnsName ↔ Output<String>
DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
latefinal
endpointIpAddress ↔ Output<String>
IP address of the endpoint that is used to access data or to manage the file system.
latefinal
endpointIpAddressRange ↔ Output<String>
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
latefinal
finalBackupTags ↔ Output<Map<String, String>?>
Map of tags to apply to the file system's final backup.
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
kmsKeyId ↔ Output<String>
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
latefinal
networkInterfaceIds ↔ Output<List<String>>
Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
latefinal
networkType ↔ Output<String>
Network type. Valid values are IPV4 and DUAL. Default value is IPV4.
latefinal
ownerId ↔ Output<String>
AWS account identifier that created the file system.
latefinal
preferredSubnetId ↔ Output<String?>
(Multi-AZ only) Required when deploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
latefinal
readCacheConfiguration ↔ Output<OpenZfsFileSystemReadCacheConfiguration?>
Configuration block for optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class. Required when storageType is set to INTELLIGENT_TIERING. See readCacheConfiguration Block for details.
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
rootVolumeConfiguration ↔ Output<OpenZfsFileSystemRootVolumeConfiguration>
Configuration for the root volume of the file system. All other volumes are children or the root volume. See rootVolumeConfiguration Block for details.
latefinal
rootVolumeId ↔ Output<String>
Identifier of the root volume, e.g., fsvol-12345678
latefinal
routeTableIds ↔ Output<List<String>>
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds ↔ Output<List<String>?>
List of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
latefinal
skipFinalBackup ↔ Output<bool?>
When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
latefinal
storageCapacity ↔ Output<int?>
Storage capacity (GiB) of the file system. Valid values between 64 and 524288. Required when storageType is set to SSD. Must not be set when storageType is set to INTELLIGENT_TIERING.
latefinal
storageType ↔ Output<String?>
Filesystem storage type. Valid values are SSD and INTELLIGENT_TIERING. INTELLIGENT_TIERING requires deploymentType to be MULTI_AZ_1.
latefinal
subnetIds ↔ Output<List<String>>
List of IDs for the subnets that the file system will be accessible from.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
throughputCapacity ↔ Output<int>
Throughput (MB/s) of the file system. Valid values depend on deploymentType. Must be one of 64, 128, 256, 512, 1024, 2048, 3072, 4096 for SINGLE_AZ_1. Must be one of 160, 320, 640, 1280, 2560, 3840, 5120, 7680, 10240 for SINGLE_AZ_2.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcId ↔ Output<String>
Identifier of the VPC for the file system.
latefinal
weeklyMaintenanceStartTime ↔ Output<String>
Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
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, {OpenZfsFileSystemState? state, CustomResourceOptions? options}) → OpenZfsFileSystem
Gets an existing OpenZfsFileSystem resource's state with the given name and id.