pulumi-aws-kotlin/com.pulumi.aws.fsx.kotlin/OpenZfsFileSystem

OpenZfsFileSystem

class OpenZfsFileSystem : KotlinCustomResource

Manages an Amazon FSx for OpenZFS file system. See the FSx OpenZFS User Guide for more information.

Example Usage

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(aws_subnet.test1().id())
            .deploymentType("SINGLE_AZ_1")
            .throughputCapacity(64)
            .build());
    }
}

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:

Properties

arn

val arn: Output<String>

Amazon Resource Name of the file system.

automaticBackupRetentionDays

val automaticBackupRetentionDays: Output<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

val backupId: Output<String>?

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

copyTagsToBackups

val copyTagsToBackups: Output<Boolean>?

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

copyTagsToVolumes

val copyTagsToVolumes: Output<Boolean>?

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

dailyAutomaticBackupStartTime

val dailyAutomaticBackupStartTime: Output<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

val deploymentType: Output<String>

The filesystem deployment type. Valid values: SINGLE_AZ_1, SINGLE_AZ_2 and MULTI_AZ_1.

diskIopsConfiguration

val diskIopsConfiguration: Output<OpenZfsFileSystemDiskIopsConfiguration>

The SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See Disk Iops Configuration below.

dnsName

val dnsName: Output<String>

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

endpointIpAddressRange

val endpointIpAddressRange: Output<String>

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

val id: Output<String>

kmsKeyId

val kmsKeyId: Output<String>

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

networkInterfaceIds

val networkInterfaceIds: Output<List<String>>

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

ownerId

val ownerId: Output<String>

AWS account identifier that created the file system.

preferredSubnetId

val preferredSubnetId: Output<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.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

rootVolumeConfiguration

val rootVolumeConfiguration: Output<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

val rootVolumeId: Output<String>

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

routeTableIds

val routeTableIds: Output<List<String>>

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all 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

val securityGroupIds: Output<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.

storageCapacity

val storageCapacity: Output<Int>?

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

storageType

val storageType: Output<String>?

The filesystem storage type. Only SSD is supported.

subnetIds

val subnetIds: Output<String>

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