AWS v6.71.0, Mar 7 25

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.fsx.OpenZfsFileSystem

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

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)

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.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
	})
}

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 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.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 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

Create OpenZfsFileSystem Resource

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

Constructor syntax

new OpenZfsFileSystem(name: string, args: OpenZfsFileSystemArgs, opts?: CustomResourceOptions);

@overload
def OpenZfsFileSystem(resource_name: str,
                      args: OpenZfsFileSystemArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def OpenZfsFileSystem(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      deployment_type: Optional[str] = None,
                      throughput_capacity: Optional[int] = None,
                      subnet_ids: Optional[Sequence[str]] = None,
                      kms_key_id: Optional[str] = None,
                      root_volume_configuration: Optional[OpenZfsFileSystemRootVolumeConfigurationArgs] = None,
                      delete_options: Optional[Sequence[str]] = None,
                      copy_tags_to_volumes: Optional[bool] = None,
                      disk_iops_configuration: Optional[OpenZfsFileSystemDiskIopsConfigurationArgs] = None,
                      endpoint_ip_address_range: Optional[str] = None,
                      final_backup_tags: Optional[Mapping[str, str]] = None,
                      automatic_backup_retention_days: Optional[int] = None,
                      preferred_subnet_id: Optional[str] = None,
                      daily_automatic_backup_start_time: Optional[str] = None,
                      route_table_ids: Optional[Sequence[str]] = None,
                      security_group_ids: Optional[Sequence[str]] = None,
                      skip_final_backup: Optional[bool] = None,
                      storage_capacity: Optional[int] = None,
                      storage_type: Optional[str] = None,
                      copy_tags_to_backups: Optional[bool] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      backup_id: Optional[str] = None,
                      weekly_maintenance_start_time: Optional[str] = None)

func NewOpenZfsFileSystem(ctx *Context, name string, args OpenZfsFileSystemArgs, opts ...ResourceOption) (*OpenZfsFileSystem, error)

public OpenZfsFileSystem(string name, OpenZfsFileSystemArgs args, CustomResourceOptions? opts = null)

public OpenZfsFileSystem(String name, OpenZfsFileSystemArgs args)
public OpenZfsFileSystem(String name, OpenZfsFileSystemArgs args, CustomResourceOptions options)

type: aws:fsx:OpenZfsFileSystem
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 OpenZfsFileSystemArgs: 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 OpenZfsFileSystemArgs: 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 OpenZfsFileSystemArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OpenZfsFileSystemArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OpenZfsFileSystemArgs: 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 openZfsFileSystemResource = new Aws.Fsx.OpenZfsFileSystem("openZfsFileSystemResource", new()
{
    DeploymentType = "string",
    ThroughputCapacity = 0,
    SubnetIds = new[]
    {
        "string",
    },
    KmsKeyId = "string",
    RootVolumeConfiguration = new Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfigurationArgs
    {
        CopyTagsToSnapshots = false,
        DataCompressionType = "string",
        NfsExports = new Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfigurationNfsExportsArgs
        {
            ClientConfigurations = new[]
            {
                new Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfigurationArgs
                {
                    Clients = "string",
                    Options = new[]
                    {
                        "string",
                    },
                },
            },
        },
        ReadOnly = false,
        RecordSizeKib = 0,
        UserAndGroupQuotas = new[]
        {
            new Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuotaArgs
            {
                Id = 0,
                StorageCapacityQuotaGib = 0,
                Type = "string",
            },
        },
    },
    DeleteOptions = new[]
    {
        "string",
    },
    CopyTagsToVolumes = false,
    DiskIopsConfiguration = new Aws.Fsx.Inputs.OpenZfsFileSystemDiskIopsConfigurationArgs
    {
        Iops = 0,
        Mode = "string",
    },
    EndpointIpAddressRange = "string",
    FinalBackupTags = 
    {
        { "string", "string" },
    },
    AutomaticBackupRetentionDays = 0,
    PreferredSubnetId = "string",
    DailyAutomaticBackupStartTime = "string",
    RouteTableIds = new[]
    {
        "string",
    },
    SecurityGroupIds = new[]
    {
        "string",
    },
    SkipFinalBackup = false,
    StorageCapacity = 0,
    StorageType = "string",
    CopyTagsToBackups = false,
    Tags = 
    {
        { "string", "string" },
    },
    BackupId = "string",
    WeeklyMaintenanceStartTime = "string",
});

example, err := fsx.NewOpenZfsFileSystem(ctx, "openZfsFileSystemResource", &fsx.OpenZfsFileSystemArgs{
	DeploymentType:     pulumi.String("string"),
	ThroughputCapacity: pulumi.Int(0),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsKeyId: pulumi.String("string"),
	RootVolumeConfiguration: &fsx.OpenZfsFileSystemRootVolumeConfigurationArgs{
		CopyTagsToSnapshots: pulumi.Bool(false),
		DataCompressionType: pulumi.String("string"),
		NfsExports: &fsx.OpenZfsFileSystemRootVolumeConfigurationNfsExportsArgs{
			ClientConfigurations: fsx.OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfigurationArray{
				&fsx.OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfigurationArgs{
					Clients: pulumi.String("string"),
					Options: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
		ReadOnly:      pulumi.Bool(false),
		RecordSizeKib: pulumi.Int(0),
		UserAndGroupQuotas: fsx.OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuotaArray{
			&fsx.OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuotaArgs{
				Id:                      pulumi.Int(0),
				StorageCapacityQuotaGib: pulumi.Int(0),
				Type:                    pulumi.String("string"),
			},
		},
	},
	DeleteOptions: pulumi.StringArray{
		pulumi.String("string"),
	},
	CopyTagsToVolumes: pulumi.Bool(false),
	DiskIopsConfiguration: &fsx.OpenZfsFileSystemDiskIopsConfigurationArgs{
		Iops: pulumi.Int(0),
		Mode: pulumi.String("string"),
	},
	EndpointIpAddressRange: pulumi.String("string"),
	FinalBackupTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutomaticBackupRetentionDays:  pulumi.Int(0),
	PreferredSubnetId:             pulumi.String("string"),
	DailyAutomaticBackupStartTime: pulumi.String("string"),
	RouteTableIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SkipFinalBackup:   pulumi.Bool(false),
	StorageCapacity:   pulumi.Int(0),
	StorageType:       pulumi.String("string"),
	CopyTagsToBackups: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BackupId:                   pulumi.String("string"),
	WeeklyMaintenanceStartTime: pulumi.String("string"),
})

var openZfsFileSystemResource = new OpenZfsFileSystem("openZfsFileSystemResource", OpenZfsFileSystemArgs.builder()
    .deploymentType("string")
    .throughputCapacity(0)
    .subnetIds("string")
    .kmsKeyId("string")
    .rootVolumeConfiguration(OpenZfsFileSystemRootVolumeConfigurationArgs.builder()
        .copyTagsToSnapshots(false)
        .dataCompressionType("string")
        .nfsExports(OpenZfsFileSystemRootVolumeConfigurationNfsExportsArgs.builder()
            .clientConfigurations(OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfigurationArgs.builder()
                .clients("string")
                .options("string")
                .build())
            .build())
        .readOnly(false)
        .recordSizeKib(0)
        .userAndGroupQuotas(OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuotaArgs.builder()
            .id(0)
            .storageCapacityQuotaGib(0)
            .type("string")
            .build())
        .build())
    .deleteOptions("string")
    .copyTagsToVolumes(false)
    .diskIopsConfiguration(OpenZfsFileSystemDiskIopsConfigurationArgs.builder()
        .iops(0)
        .mode("string")
        .build())
    .endpointIpAddressRange("string")
    .finalBackupTags(Map.of("string", "string"))
    .automaticBackupRetentionDays(0)
    .preferredSubnetId("string")
    .dailyAutomaticBackupStartTime("string")
    .routeTableIds("string")
    .securityGroupIds("string")
    .skipFinalBackup(false)
    .storageCapacity(0)
    .storageType("string")
    .copyTagsToBackups(false)
    .tags(Map.of("string", "string"))
    .backupId("string")
    .weeklyMaintenanceStartTime("string")
    .build());

open_zfs_file_system_resource = aws.fsx.OpenZfsFileSystem("openZfsFileSystemResource",
    deployment_type="string",
    throughput_capacity=0,
    subnet_ids=["string"],
    kms_key_id="string",
    root_volume_configuration={
        "copy_tags_to_snapshots": False,
        "data_compression_type": "string",
        "nfs_exports": {
            "client_configurations": [{
                "clients": "string",
                "options": ["string"],
            }],
        },
        "read_only": False,
        "record_size_kib": 0,
        "user_and_group_quotas": [{
            "id": 0,
            "storage_capacity_quota_gib": 0,
            "type": "string",
        }],
    },
    delete_options=["string"],
    copy_tags_to_volumes=False,
    disk_iops_configuration={
        "iops": 0,
        "mode": "string",
    },
    endpoint_ip_address_range="string",
    final_backup_tags={
        "string": "string",
    },
    automatic_backup_retention_days=0,
    preferred_subnet_id="string",
    daily_automatic_backup_start_time="string",
    route_table_ids=["string"],
    security_group_ids=["string"],
    skip_final_backup=False,
    storage_capacity=0,
    storage_type="string",
    copy_tags_to_backups=False,
    tags={
        "string": "string",
    },
    backup_id="string",
    weekly_maintenance_start_time="string")

const openZfsFileSystemResource = new aws.fsx.OpenZfsFileSystem("openZfsFileSystemResource", {
    deploymentType: "string",
    throughputCapacity: 0,
    subnetIds: ["string"],
    kmsKeyId: "string",
    rootVolumeConfiguration: {
        copyTagsToSnapshots: false,
        dataCompressionType: "string",
        nfsExports: {
            clientConfigurations: [{
                clients: "string",
                options: ["string"],
            }],
        },
        readOnly: false,
        recordSizeKib: 0,
        userAndGroupQuotas: [{
            id: 0,
            storageCapacityQuotaGib: 0,
            type: "string",
        }],
    },
    deleteOptions: ["string"],
    copyTagsToVolumes: false,
    diskIopsConfiguration: {
        iops: 0,
        mode: "string",
    },
    endpointIpAddressRange: "string",
    finalBackupTags: {
        string: "string",
    },
    automaticBackupRetentionDays: 0,
    preferredSubnetId: "string",
    dailyAutomaticBackupStartTime: "string",
    routeTableIds: ["string"],
    securityGroupIds: ["string"],
    skipFinalBackup: false,
    storageCapacity: 0,
    storageType: "string",
    copyTagsToBackups: false,
    tags: {
        string: "string",
    },
    backupId: "string",
    weeklyMaintenanceStartTime: "string",
});

type: aws:fsx:OpenZfsFileSystem
properties:
    automaticBackupRetentionDays: 0
    backupId: string
    copyTagsToBackups: false
    copyTagsToVolumes: false
    dailyAutomaticBackupStartTime: string
    deleteOptions:
        - string
    deploymentType: string
    diskIopsConfiguration:
        iops: 0
        mode: string
    endpointIpAddressRange: string
    finalBackupTags:
        string: string
    kmsKeyId: string
    preferredSubnetId: string
    rootVolumeConfiguration:
        copyTagsToSnapshots: false
        dataCompressionType: string
        nfsExports:
            clientConfigurations:
                - clients: string
                  options:
                    - string
        readOnly: false
        recordSizeKib: 0
        userAndGroupQuotas:
            - id: 0
              storageCapacityQuotaGib: 0
              type: string
    routeTableIds:
        - string
    securityGroupIds:
        - string
    skipFinalBackup: false
    storageCapacity: 0
    storageType: string
    subnetIds:
        - string
    tags:
        string: string
    throughputCapacity: 0
    weeklyMaintenanceStartTime: string

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

DeploymentType string

Filesystem deployment type. See the AWS API documentation for a list of valid values.

SubnetIds List<string>

A list of IDs for the subnets that the file system will be accessible from.

ThroughputCapacity int

Throughput (MB/s) of the file system. Valid values depend on deployment_type. 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.

The following arguments are optional:

AutomaticBackupRetentionDays int

The 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.

BackupId string

The ID of the source backup to create the filesystem from.

CopyTagsToBackups bool

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

CopyTagsToVolumes bool

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

DailyAutomaticBackupStartTime string

A 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 automatic_backup_retention_days to be set.

DeleteOptions 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.

DiskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

EndpointIpAddressRange string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

FinalBackupTags Dictionary<string, string>

A map of tags to apply to the file system's final backup.

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

PreferredSubnetId string

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

RootVolumeConfiguration OpenZfsFileSystemRootVolumeConfiguration

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

RouteTableIds 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 virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

SecurityGroupIds List<string>

A 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.

SkipFinalBackup 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.

StorageCapacity int

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

StorageType string

The filesystem storage type. Only SSD is supported.

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.

WeeklyMaintenanceStartTime string

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

DeploymentType string

Filesystem deployment type. See the AWS API documentation for a list of valid values.

SubnetIds []string

A list of IDs for the subnets that the file system will be accessible from.

ThroughputCapacity int

The following arguments are optional:

AutomaticBackupRetentionDays int

The 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.

BackupId string

The ID of the source backup to create the filesystem from.

CopyTagsToBackups bool

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

CopyTagsToVolumes bool

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

DailyAutomaticBackupStartTime string

DeleteOptions []string

DiskIopsConfiguration OpenZfsFileSystemDiskIopsConfigurationArgs

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

EndpointIpAddressRange string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

FinalBackupTags map[string]string

A map of tags to apply to the file system's final backup.

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

PreferredSubnetId string

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

RootVolumeConfiguration OpenZfsFileSystemRootVolumeConfigurationArgs

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

RouteTableIds []string

SecurityGroupIds []string

A 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.

SkipFinalBackup bool

StorageCapacity int

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

StorageType string

The filesystem storage type. Only SSD is supported.

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.

WeeklyMaintenanceStartTime string

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

deploymentType String

Filesystem deployment type. See the AWS API documentation for a list of valid values.

subnetIds List<String>

A list of IDs for the subnets that the file system will be accessible from.

throughputCapacity Integer

The following arguments are optional:

automaticBackupRetentionDays Integer

The 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.

backupId String

The ID of the source backup to create the filesystem from.

copyTagsToBackups Boolean

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copyTagsToVolumes Boolean

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

dailyAutomaticBackupStartTime String

deleteOptions List<String>

diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

endpointIpAddressRange String

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

finalBackupTags Map<String,String>

A map of tags to apply to the file system's final backup.

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

preferredSubnetId String

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

rootVolumeConfiguration OpenZfsFileSystemRootVolumeConfiguration

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

routeTableIds List<String>

securityGroupIds List<String>

A 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.

skipFinalBackup Boolean

storageCapacity Integer

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storageType String

The filesystem storage type. Only SSD is supported.

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.

weeklyMaintenanceStartTime String

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

deploymentType string

Filesystem deployment type. See the AWS API documentation for a list of valid values.

subnetIds string[]

A list of IDs for the subnets that the file system will be accessible from.

throughputCapacity number

The following arguments are optional:

automaticBackupRetentionDays number

The 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.

backupId string

The ID of the source backup to create the filesystem from.

copyTagsToBackups boolean

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copyTagsToVolumes boolean

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

dailyAutomaticBackupStartTime string

deleteOptions string[]

diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

endpointIpAddressRange string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

finalBackupTags {[key: string]: string}

A map of tags to apply to the file system's final backup.

kmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

preferredSubnetId string

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

rootVolumeConfiguration OpenZfsFileSystemRootVolumeConfiguration

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

routeTableIds string[]

securityGroupIds string[]

A 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.

skipFinalBackup boolean

storageCapacity number

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storageType string

The filesystem storage type. Only SSD is supported.

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.

weeklyMaintenanceStartTime string

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

deployment_type str

Filesystem deployment type. See the AWS API documentation for a list of valid values.

subnet_ids Sequence[str]

A list of IDs for the subnets that the file system will be accessible from.

throughput_capacity int

The following arguments are optional:

automatic_backup_retention_days int

The 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.

backup_id str

The ID of the source backup to create the filesystem from.

copy_tags_to_backups bool

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copy_tags_to_volumes bool

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

daily_automatic_backup_start_time str

delete_options Sequence[str]

disk_iops_configuration OpenZfsFileSystemDiskIopsConfigurationArgs

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

endpoint_ip_address_range str

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

final_backup_tags Mapping[str, str]

A map of tags to apply to the file system's final backup.

kms_key_id str

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

preferred_subnet_id str

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

root_volume_configuration OpenZfsFileSystemRootVolumeConfigurationArgs

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

route_table_ids Sequence[str]

security_group_ids Sequence[str]

A 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.

skip_final_backup bool

storage_capacity int

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storage_type str

The filesystem storage type. Only SSD is supported.

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.

weekly_maintenance_start_time str

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

deploymentType String

Filesystem deployment type. See the AWS API documentation for a list of valid values.

subnetIds List<String>

A list of IDs for the subnets that the file system will be accessible from.

throughputCapacity Number

The following arguments are optional:

automaticBackupRetentionDays Number

The 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.

backupId String

The ID of the source backup to create the filesystem from.

copyTagsToBackups Boolean

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copyTagsToVolumes Boolean

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

dailyAutomaticBackupStartTime String

deleteOptions List<String>

diskIopsConfiguration Property Map

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

endpointIpAddressRange String

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

finalBackupTags Map<String>

A map of tags to apply to the file system's final backup.

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

preferredSubnetId String

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

rootVolumeConfiguration Property Map

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

routeTableIds List<String>

securityGroupIds List<String>

A 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.

skipFinalBackup Boolean

storageCapacity Number

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storageType String

The filesystem storage type. Only SSD is supported.

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.

weeklyMaintenanceStartTime String

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

Outputs

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

Arn string: Amazon Resource Name of the file system.
DnsName string: DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
EndpointIpAddress string: IP address of the endpoint that is used to access data or to manage the file system.
Id string: The provider-assigned unique ID for this managed resource.
NetworkInterfaceIds 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.
OwnerId string: AWS account identifier that created the file system.
RootVolumeId string: Identifier of the root volume, e.g., fsvol-12345678
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.
VpcId string: Identifier of the Virtual Private Cloud for the file system.

Arn string: Amazon Resource Name of the file system.
DnsName string: DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
EndpointIpAddress string: IP address of the endpoint that is used to access data or to manage the file system.
Id string: The provider-assigned unique ID for this managed resource.
NetworkInterfaceIds []string: Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
OwnerId string: AWS account identifier that created the file system.
RootVolumeId string: Identifier of the root volume, e.g., fsvol-12345678
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.
VpcId string: Identifier of the Virtual Private Cloud for the file system.

arn String: Amazon Resource Name of the file system.
dnsName String: DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
endpointIpAddress String: IP address of the endpoint that is used to access data or to manage the file system.
id String: The provider-assigned unique ID for this managed resource.
networkInterfaceIds 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.
ownerId String: AWS account identifier that created the file system.
rootVolumeId String: Identifier of the root volume, e.g., fsvol-12345678
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.
vpcId String: Identifier of the Virtual Private Cloud for the file system.

arn string: Amazon Resource Name of the file system.
dnsName string: DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
endpointIpAddress string: IP address of the endpoint that is used to access data or to manage the file system.
id string: The provider-assigned unique ID for this managed resource.
networkInterfaceIds string[]: Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
ownerId string: AWS account identifier that created the file system.
rootVolumeId string: Identifier of the root volume, e.g., fsvol-12345678
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.
vpcId string: Identifier of the Virtual Private Cloud for the file system.

arn str: Amazon Resource Name of the file system.
dns_name str: DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
endpoint_ip_address str: IP address of the endpoint that is used to access data or to manage the file system.
id str: The provider-assigned unique ID for this managed resource.
network_interface_ids Sequence[str]: Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
owner_id str: AWS account identifier that created the file system.
root_volume_id str: Identifier of the root volume, e.g., fsvol-12345678
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.
vpc_id str: Identifier of the Virtual Private Cloud for the file system.

arn String: Amazon Resource Name of the file system.
dnsName String: DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
endpointIpAddress String: IP address of the endpoint that is used to access data or to manage the file system.
id String: The provider-assigned unique ID for this managed resource.
networkInterfaceIds 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.
ownerId String: AWS account identifier that created the file system.
rootVolumeId String: Identifier of the root volume, e.g., fsvol-12345678
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.
vpcId String: Identifier of the Virtual Private Cloud for the file system.

Look up Existing OpenZfsFileSystem Resource

Get an existing OpenZfsFileSystem 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?: OpenZfsFileSystemState, opts?: CustomResourceOptions): OpenZfsFileSystem

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        automatic_backup_retention_days: Optional[int] = None,
        backup_id: Optional[str] = None,
        copy_tags_to_backups: Optional[bool] = None,
        copy_tags_to_volumes: Optional[bool] = None,
        daily_automatic_backup_start_time: Optional[str] = None,
        delete_options: Optional[Sequence[str]] = None,
        deployment_type: Optional[str] = None,
        disk_iops_configuration: Optional[OpenZfsFileSystemDiskIopsConfigurationArgs] = None,
        dns_name: Optional[str] = None,
        endpoint_ip_address: Optional[str] = None,
        endpoint_ip_address_range: Optional[str] = None,
        final_backup_tags: Optional[Mapping[str, str]] = None,
        kms_key_id: Optional[str] = None,
        network_interface_ids: Optional[Sequence[str]] = None,
        owner_id: Optional[str] = None,
        preferred_subnet_id: Optional[str] = None,
        root_volume_configuration: Optional[OpenZfsFileSystemRootVolumeConfigurationArgs] = None,
        root_volume_id: Optional[str] = None,
        route_table_ids: Optional[Sequence[str]] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        skip_final_backup: Optional[bool] = None,
        storage_capacity: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        throughput_capacity: Optional[int] = None,
        vpc_id: Optional[str] = None,
        weekly_maintenance_start_time: Optional[str] = None) -> OpenZfsFileSystem

func GetOpenZfsFileSystem(ctx *Context, name string, id IDInput, state *OpenZfsFileSystemState, opts ...ResourceOption) (*OpenZfsFileSystem, error)

public static OpenZfsFileSystem Get(string name, Input<string> id, OpenZfsFileSystemState? state, CustomResourceOptions? opts = null)

public static OpenZfsFileSystem get(String name, Output<String> id, OpenZfsFileSystemState state, CustomResourceOptions options)

resources:  _:    type: aws:fsx:OpenZfsFileSystem    get:      id: ${id}

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.

AutomaticBackupRetentionDays int

The 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.

BackupId string

The ID of the source backup to create the filesystem from.

CopyTagsToBackups bool

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

CopyTagsToVolumes bool

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

DailyAutomaticBackupStartTime string

DeleteOptions List<string>

DeploymentType string

Filesystem deployment type. See the AWS API documentation for a list of valid values.

DiskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

DnsName string

DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com

EndpointIpAddress string

IP address of the endpoint that is used to access data or to manage the file system.

EndpointIpAddressRange string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

FinalBackupTags Dictionary<string, string>

A map of tags to apply to the file system's final backup.

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

NetworkInterfaceIds 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.

OwnerId string

AWS account identifier that created the file system.

PreferredSubnetId string

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

RootVolumeConfiguration OpenZfsFileSystemRootVolumeConfiguration

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

RootVolumeId string

Identifier of the root volume, e.g., fsvol-12345678

RouteTableIds List<string>

SecurityGroupIds List<string>

A 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.

SkipFinalBackup bool

StorageCapacity int

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

StorageType string

The filesystem storage type. Only SSD is supported.

SubnetIds List<string>

A list of IDs for the subnets that the file system will be accessible from.

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.

ThroughputCapacity int

The following arguments are optional:

VpcId string

Identifier of the Virtual Private Cloud for the file system.

WeeklyMaintenanceStartTime string

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

Arn string

Amazon Resource Name of the file system.

AutomaticBackupRetentionDays int

The 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.

BackupId string

The ID of the source backup to create the filesystem from.

CopyTagsToBackups bool

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

CopyTagsToVolumes bool

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

DailyAutomaticBackupStartTime string

DeleteOptions []string

DeploymentType string

Filesystem deployment type. See the AWS API documentation for a list of valid values.

DiskIopsConfiguration OpenZfsFileSystemDiskIopsConfigurationArgs

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

DnsName string

DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com

EndpointIpAddress string

IP address of the endpoint that is used to access data or to manage the file system.

EndpointIpAddressRange string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

FinalBackupTags map[string]string

A map of tags to apply to the file system's final backup.

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

NetworkInterfaceIds []string

Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.

OwnerId string

AWS account identifier that created the file system.

PreferredSubnetId string

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

RootVolumeConfiguration OpenZfsFileSystemRootVolumeConfigurationArgs

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

RootVolumeId string

Identifier of the root volume, e.g., fsvol-12345678

RouteTableIds []string

SecurityGroupIds []string

A 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.

SkipFinalBackup bool

StorageCapacity int

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

StorageType string

The filesystem storage type. Only SSD is supported.

SubnetIds []string

A list of IDs for the subnets that the file system will be accessible from.

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.

ThroughputCapacity int

The following arguments are optional:

VpcId string

Identifier of the Virtual Private Cloud for the file system.

WeeklyMaintenanceStartTime string

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

arn String

Amazon Resource Name of the file system.

automaticBackupRetentionDays Integer

The 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.

backupId String

The ID of the source backup to create the filesystem from.

copyTagsToBackups Boolean

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copyTagsToVolumes Boolean

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

dailyAutomaticBackupStartTime String

deleteOptions List<String>

deploymentType String

Filesystem deployment type. See the AWS API documentation for a list of valid values.

diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

dnsName String

DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com

endpointIpAddress String

IP address of the endpoint that is used to access data or to manage the file system.

endpointIpAddressRange String

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

finalBackupTags Map<String,String>

A map of tags to apply to the file system's final backup.

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

networkInterfaceIds 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.

ownerId String

AWS account identifier that created the file system.

preferredSubnetId String

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

rootVolumeConfiguration OpenZfsFileSystemRootVolumeConfiguration

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

rootVolumeId String

Identifier of the root volume, e.g., fsvol-12345678

routeTableIds List<String>

securityGroupIds List<String>

A 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.

skipFinalBackup Boolean

storageCapacity Integer

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storageType String

The filesystem storage type. Only SSD is supported.

subnetIds List<String>

A list of IDs for the subnets that the file system will be accessible from.

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.

throughputCapacity Integer

The following arguments are optional:

vpcId String

Identifier of the Virtual Private Cloud for the file system.

weeklyMaintenanceStartTime String

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

arn string

Amazon Resource Name of the file system.

automaticBackupRetentionDays number

The 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.

backupId string

The ID of the source backup to create the filesystem from.

copyTagsToBackups boolean

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copyTagsToVolumes boolean

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

dailyAutomaticBackupStartTime string

deleteOptions string[]

deploymentType string

Filesystem deployment type. See the AWS API documentation for a list of valid values.

diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

dnsName string

DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com

endpointIpAddress string

IP address of the endpoint that is used to access data or to manage the file system.

endpointIpAddressRange string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

finalBackupTags {[key: string]: string}

A map of tags to apply to the file system's final backup.

kmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

networkInterfaceIds string[]

Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.

ownerId string

AWS account identifier that created the file system.

preferredSubnetId string

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

rootVolumeConfiguration OpenZfsFileSystemRootVolumeConfiguration

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

rootVolumeId string

Identifier of the root volume, e.g., fsvol-12345678

routeTableIds string[]

securityGroupIds string[]

A 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.

skipFinalBackup boolean

storageCapacity number

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storageType string

The filesystem storage type. Only SSD is supported.

subnetIds string[]

A list of IDs for the subnets that the file system will be accessible from.

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.

throughputCapacity number

The following arguments are optional:

vpcId string

Identifier of the Virtual Private Cloud for the file system.

weeklyMaintenanceStartTime string

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

arn str

Amazon Resource Name of the file system.

automatic_backup_retention_days int

The 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.

backup_id str

The ID of the source backup to create the filesystem from.

copy_tags_to_backups bool

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copy_tags_to_volumes bool

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

daily_automatic_backup_start_time str

delete_options Sequence[str]

deployment_type str

Filesystem deployment type. See the AWS API documentation for a list of valid values.

disk_iops_configuration OpenZfsFileSystemDiskIopsConfigurationArgs

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

dns_name str

DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com

endpoint_ip_address str

IP address of the endpoint that is used to access data or to manage the file system.

endpoint_ip_address_range str

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

final_backup_tags Mapping[str, str]

A map of tags to apply to the file system's final backup.

kms_key_id str

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

network_interface_ids Sequence[str]

Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.

owner_id str

AWS account identifier that created the file system.

preferred_subnet_id str

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

root_volume_configuration OpenZfsFileSystemRootVolumeConfigurationArgs

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

root_volume_id str

Identifier of the root volume, e.g., fsvol-12345678

route_table_ids Sequence[str]

security_group_ids Sequence[str]

A 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.

skip_final_backup bool

storage_capacity int

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storage_type str

The filesystem storage type. Only SSD is supported.

subnet_ids Sequence[str]

A list of IDs for the subnets that the file system will be accessible from.

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.

throughput_capacity int

The following arguments are optional:

vpc_id str

Identifier of the Virtual Private Cloud for the file system.

weekly_maintenance_start_time str

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

arn String

Amazon Resource Name of the file system.

automaticBackupRetentionDays Number

The 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.

backupId String

The ID of the source backup to create the filesystem from.

copyTagsToBackups Boolean

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false.

copyTagsToVolumes Boolean

A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.

dailyAutomaticBackupStartTime String

deleteOptions List<String>

deploymentType String

Filesystem deployment type. See the AWS API documentation for a list of valid values.

diskIopsConfiguration Property Map

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See disk_iops_configuration Block for details.

dnsName String

DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com

endpointIpAddress String

IP address of the endpoint that is used to access data or to manage the file system.

endpointIpAddressRange String

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

finalBackupTags Map<String>

A map of tags to apply to the file system's final backup.

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.

networkInterfaceIds 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.

ownerId String

AWS account identifier that created the file system.

preferredSubnetId String

(Multi-AZ only) Required when deployment_type is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

rootVolumeConfiguration Property Map

The configuration for the root volume of the file system. All other volumes are children or the root volume. See root_volume_configuration Block for details.

rootVolumeId String

Identifier of the root volume, e.g., fsvol-12345678

routeTableIds List<String>

securityGroupIds List<String>

A 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.

skipFinalBackup Boolean

storageCapacity Number

The storage capacity (GiB) of the file system. Valid values between 64 and 524288.

storageType String

The filesystem storage type. Only SSD is supported.

subnetIds List<String>

A list of IDs for the subnets that the file system will be accessible from.

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.

throughputCapacity Number

The following arguments are optional:

vpcId String

Identifier of the Virtual Private Cloud for the file system.

weeklyMaintenanceStartTime String

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

Supporting Types

OpenZfsFileSystemDiskIopsConfiguration, OpenZfsFileSystemDiskIopsConfigurationArgs

Iops int: The total number of SSD IOPS provisioned for the file system.
Mode string: Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

Iops int: The total number of SSD IOPS provisioned for the file system.
Mode string: Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

iops Integer: The total number of SSD IOPS provisioned for the file system.
mode String: Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

iops number: The total number of SSD IOPS provisioned for the file system.
mode string: Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

iops int: The total number of SSD IOPS provisioned for the file system.
mode str: Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

iops Number: The total number of SSD IOPS provisioned for the file system.
mode String: Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

OpenZfsFileSystemRootVolumeConfiguration, OpenZfsFileSystemRootVolumeConfigurationArgs

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 LZ4, 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.
NfsExports OpenZfsFileSystemRootVolumeConfigurationNfsExports: NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block for details.
ReadOnly bool: specifies whether the volume is read-only. Default is false.
RecordSizeKib int: Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
UserAndGroupQuotas List<OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota>: Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block for details.

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 LZ4, 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.
NfsExports OpenZfsFileSystemRootVolumeConfigurationNfsExports: NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block for details.
ReadOnly bool: specifies whether the volume is read-only. Default is false.
RecordSizeKib int: Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
UserAndGroupQuotas []OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota: Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block for details.

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 LZ4, 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.
nfsExports OpenZfsFileSystemRootVolumeConfigurationNfsExports: NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block for details.
readOnly Boolean: specifies whether the volume is read-only. Default is false.
recordSizeKib Integer: Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
userAndGroupQuotas List<OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota>: Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block for details.

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 LZ4, 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.
nfsExports OpenZfsFileSystemRootVolumeConfigurationNfsExports: NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block for details.
readOnly boolean: specifies whether the volume is read-only. Default is false.
recordSizeKib number: Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
userAndGroupQuotas OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota[]: Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block for details.

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 LZ4, 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.
nfs_exports OpenZfsFileSystemRootVolumeConfigurationNfsExports: NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block for details.
read_only bool: specifies whether the volume is read-only. Default is false.
record_size_kib int: Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
user_and_group_quotas Sequence[OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota]: Specify how much storage users or groups can use on the volume. Maximum of 100 items. See user_and_group_quotas Block for details.

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 LZ4, 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.
nfsExports Property Map: NFS export configuration for the root volume. Exactly 1 item. See nfs_exports Block for details.
readOnly Boolean: specifies whether the volume is read-only. Default is false.
recordSizeKib Number: Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
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 for details.

OpenZfsFileSystemRootVolumeConfigurationNfsExports, OpenZfsFileSystemRootVolumeConfigurationNfsExportsArgs

ClientConfigurations List<OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration>: 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 for details.

ClientConfigurations []OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration: 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 for details.

clientConfigurations List<OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration>: 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 for details.

clientConfigurations OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration[]: 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 for details.

client_configurations Sequence[OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration]: 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 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 for details.

OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration, OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfigurationArgs

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.

OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota, OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuotaArgs

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: A value that specifies whether the quota applies to a user or group. Valid values are USER or GROUP.

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: A value that specifies whether the quota applies to a user or group. Valid values are USER or GROUP.

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: A value that specifies whether the quota applies to a user or group. Valid values are USER or GROUP.

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: A value that specifies whether the quota applies to a user or group. Valid values are USER or GROUP.

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: A value that specifies whether the quota applies to a user or group. Valid values are USER or GROUP.

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: A value that specifies whether the quota applies to a user or group. Valid values are USER or GROUP.

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 security_group_ids, 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 ignore_changes to hide the difference. For example:

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.

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.fsx.OpenZfsFileSystem

On this page

On this page

Example Usage

Create OpenZfsFileSystem Resource

Constructor syntax

Parameters

Constructor example

OpenZfsFileSystem Resource Properties

Inputs

Outputs

Look up Existing OpenZfsFileSystem Resource

Supporting Types

OpenZfsFileSystemDiskIopsConfiguration, OpenZfsFileSystemDiskIopsConfigurationArgs

OpenZfsFileSystemRootVolumeConfiguration, OpenZfsFileSystemRootVolumeConfigurationArgs

OpenZfsFileSystemRootVolumeConfigurationNfsExports, OpenZfsFileSystemRootVolumeConfigurationNfsExportsArgs

OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfiguration, OpenZfsFileSystemRootVolumeConfigurationNfsExportsClientConfigurationArgs

OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota, OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuotaArgs

Import

Package Details

On this page

On this page