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

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

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

aws.fsx.OpenZfsFileSystem

Explore with Pulumi AI

aws logo

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

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

    Manages an Amazon FSx for OpenZFS 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)
    
    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.Any(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 = 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

    new OpenZfsFileSystem(name: string, args: OpenZfsFileSystemArgs, opts?: CustomResourceOptions);
    @overload
    def OpenZfsFileSystem(resource_name: str,
                          opts: Optional[ResourceOptions] = 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,
                          deployment_type: Optional[str] = None,
                          disk_iops_configuration: Optional[OpenZfsFileSystemDiskIopsConfigurationArgs] = None,
                          endpoint_ip_address_range: Optional[str] = None,
                          kms_key_id: Optional[str] = None,
                          preferred_subnet_id: Optional[str] = None,
                          root_volume_configuration: Optional[OpenZfsFileSystemRootVolumeConfigurationArgs] = 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[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          throughput_capacity: Optional[int] = None,
                          weekly_maintenance_start_time: Optional[str] = None)
    @overload
    def OpenZfsFileSystem(resource_name: str,
                          args: OpenZfsFileSystemArgs,
                          opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The OpenZfsFileSystem resource accepts the following input properties:

    DeploymentType string
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    SubnetIds 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.
    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.
    DiskIopsConfiguration Pulumi.Aws.Fsx.Inputs.OpenZfsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    EndpointIpAddressRange string
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 Pulumi.Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfiguration
    The configuration for the root volume of the file system. All other volumes are children or the root volume. See Root Volume Configuration below.
    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
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    SubnetIds 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.
    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.
    DiskIopsConfiguration OpenZfsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    EndpointIpAddressRange string
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    RouteTableIds []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 []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 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
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    subnetIds String
    A list of IDs for the subnets that the file system will be accessible from.
    throughputCapacity Integer
    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.
    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
    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.
    diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    endpointIpAddressRange String
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    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 Boolean
    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 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
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    subnetIds string
    A list of IDs for the subnets that the file system will be accessible from.
    throughputCapacity number
    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.
    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
    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.
    diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    endpointIpAddressRange string
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    routeTableIds 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 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
    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 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
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    subnet_ids str
    A list of IDs for the subnets that the file system will be accessible from.
    throughput_capacity 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.
    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
    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.
    disk_iops_configuration OpenZfsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    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.
    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 below.
    route_table_ids Sequence[str]
    (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.
    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
    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.
    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
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    subnetIds String
    A list of IDs for the subnets that the file system will be accessible from.
    throughputCapacity Number
    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.
    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
    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.
    diskIopsConfiguration Property Map
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    endpointIpAddressRange String
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    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 Boolean
    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 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
    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
    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
    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
    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
    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
    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,
            deployment_type: Optional[str] = None,
            disk_iops_configuration: Optional[OpenZfsFileSystemDiskIopsConfigurationArgs] = None,
            dns_name: Optional[str] = None,
            endpoint_ip_address_range: Optional[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[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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name of the file system.
    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.
    DeploymentType string
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    DiskIopsConfiguration Pulumi.Aws.Fsx.Inputs.OpenZfsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    DnsName string
    DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
    EndpointIpAddressRange string
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 Pulumi.Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfiguration
    The configuration for the root volume of the file system. All other volumes are children or the root volume. See Root Volume Configuration below.
    RootVolumeId string
    Identifier of the root volume, e.g., fsvol-12345678
    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.
    SubnetIds 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
    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.
    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
    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.
    DeploymentType string
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    DiskIopsConfiguration OpenZfsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    DnsName string
    DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
    EndpointIpAddressRange string
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    RootVolumeId string
    Identifier of the root volume, e.g., fsvol-12345678
    RouteTableIds []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 []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.
    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
    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.
    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
    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.
    deploymentType String
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    dnsName String
    DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
    endpointIpAddressRange String
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    rootVolumeId String
    Identifier of the root volume, e.g., fsvol-12345678
    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 Boolean
    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 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 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
    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.
    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
    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.
    deploymentType string
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    diskIopsConfiguration OpenZfsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    dnsName string
    DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
    endpointIpAddressRange string
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    rootVolumeId string
    Identifier of the root volume, e.g., fsvol-12345678
    routeTableIds 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 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
    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 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
    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.
    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
    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.
    deployment_type str
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    disk_iops_configuration OpenZfsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    dns_name str
    DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
    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.
    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 below.
    root_volume_id str
    Identifier of the root volume, e.g., fsvol-12345678
    route_table_ids Sequence[str]
    (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.
    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
    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.
    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 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
    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.
    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
    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.
    deploymentType String
    The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.
    diskIopsConfiguration Property Map
    The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.
    dnsName String
    DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
    endpointIpAddressRange String
    (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
    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 below.
    rootVolumeId String
    Identifier of the root volume, e.g., fsvol-12345678
    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 Boolean
    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 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 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
    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.
    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 Pulumi.Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfigurationNfsExports
    NFS export configuration for the root volume. Exactly 1 item. See NFS Exports Below.
    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<Pulumi.Aws.Fsx.Inputs.OpenZfsFileSystemRootVolumeConfigurationUserAndGroupQuota>
    Specify how much storage users or groups can use on the volume. Maximum of 100 items. See User and Group Quotas Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.

    OpenZfsFileSystemRootVolumeConfigurationNfsExports, OpenZfsFileSystemRootVolumeConfigurationNfsExportsArgs

    ClientConfigurations List<Pulumi.Aws.Fsx.Inputs.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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.
    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 Below.

    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:

    Package Details

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

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

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