AWS v6.71.0, Mar 7 25

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

aws.fsx.LustreFileSystem

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 example = new aws.fsx.LustreFileSystem("example", {
    importPath: `s3://${exampleAwsS3Bucket.bucket}`,
    storageCapacity: 1200,
    subnetIds: exampleAwsSubnet.id,
});

import pulumi
import pulumi_aws as aws

example = aws.fsx.LustreFileSystem("example",
    import_path=f"s3://{example_aws_s3_bucket['bucket']}",
    storage_capacity=1200,
    subnet_ids=example_aws_subnet["id"])

package main

import (
	"fmt"

	"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.NewLustreFileSystem(ctx, "example", &fsx.LustreFileSystemArgs{
			ImportPath:      pulumi.Sprintf("s3://%v", exampleAwsS3Bucket.Bucket),
			StorageCapacity: pulumi.Int(1200),
			SubnetIds:       pulumi.Any(exampleAwsSubnet.Id),
		})
		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 example = new Aws.Fsx.LustreFileSystem("example", new()
    {
        ImportPath = $"s3://{exampleAwsS3Bucket.Bucket}",
        StorageCapacity = 1200,
        SubnetIds = exampleAwsSubnet.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.LustreFileSystem;
import com.pulumi.aws.fsx.LustreFileSystemArgs;
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 example = new LustreFileSystem("example", LustreFileSystemArgs.builder()
            .importPath(String.format("s3://%s", exampleAwsS3Bucket.bucket()))
            .storageCapacity(1200)
            .subnetIds(exampleAwsSubnet.id())
            .build());

    }
}

resources:
  example:
    type: aws:fsx:LustreFileSystem
    properties:
      importPath: s3://${exampleAwsS3Bucket.bucket}
      storageCapacity: 1200
      subnetIds: ${exampleAwsSubnet.id}

Create LustreFileSystem Resource

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

Constructor syntax

new LustreFileSystem(name: string, args: LustreFileSystemArgs, opts?: CustomResourceOptions);

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

@overload
def LustreFileSystem(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     subnet_ids: Optional[str] = None,
                     import_path: Optional[str] = None,
                     data_compression_type: Optional[str] = None,
                     imported_file_chunk_size: Optional[int] = None,
                     daily_automatic_backup_start_time: Optional[str] = None,
                     kms_key_id: Optional[str] = None,
                     deployment_type: Optional[str] = None,
                     drive_cache_type: Optional[str] = None,
                     log_configuration: Optional[LustreFileSystemLogConfigurationArgs] = None,
                     export_path: Optional[str] = None,
                     file_system_type_version: Optional[str] = None,
                     final_backup_tags: Optional[Mapping[str, str]] = None,
                     auto_import_policy: Optional[str] = None,
                     copy_tags_to_backups: Optional[bool] = None,
                     backup_id: Optional[str] = None,
                     efa_enabled: Optional[bool] = None,
                     metadata_configuration: Optional[LustreFileSystemMetadataConfigurationArgs] = None,
                     per_unit_storage_throughput: Optional[int] = None,
                     root_squash_configuration: Optional[LustreFileSystemRootSquashConfigurationArgs] = None,
                     security_group_ids: Optional[Sequence[str]] = None,
                     skip_final_backup: Optional[bool] = None,
                     storage_capacity: Optional[int] = None,
                     storage_type: Optional[str] = None,
                     automatic_backup_retention_days: Optional[int] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     weekly_maintenance_start_time: Optional[str] = None)

func NewLustreFileSystem(ctx *Context, name string, args LustreFileSystemArgs, opts ...ResourceOption) (*LustreFileSystem, error)

public LustreFileSystem(string name, LustreFileSystemArgs args, CustomResourceOptions? opts = null)

public LustreFileSystem(String name, LustreFileSystemArgs args)
public LustreFileSystem(String name, LustreFileSystemArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args LustreFileSystemArgs: 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 lustreFileSystemResource = new Aws.Fsx.LustreFileSystem("lustreFileSystemResource", new()
{
    SubnetIds = "string",
    ImportPath = "string",
    DataCompressionType = "string",
    ImportedFileChunkSize = 0,
    DailyAutomaticBackupStartTime = "string",
    KmsKeyId = "string",
    DeploymentType = "string",
    DriveCacheType = "string",
    LogConfiguration = new Aws.Fsx.Inputs.LustreFileSystemLogConfigurationArgs
    {
        Destination = "string",
        Level = "string",
    },
    ExportPath = "string",
    FileSystemTypeVersion = "string",
    FinalBackupTags = 
    {
        { "string", "string" },
    },
    AutoImportPolicy = "string",
    CopyTagsToBackups = false,
    BackupId = "string",
    EfaEnabled = false,
    MetadataConfiguration = new Aws.Fsx.Inputs.LustreFileSystemMetadataConfigurationArgs
    {
        Iops = 0,
        Mode = "string",
    },
    PerUnitStorageThroughput = 0,
    RootSquashConfiguration = new Aws.Fsx.Inputs.LustreFileSystemRootSquashConfigurationArgs
    {
        NoSquashNids = new[]
        {
            "string",
        },
        RootSquash = "string",
    },
    SecurityGroupIds = new[]
    {
        "string",
    },
    SkipFinalBackup = false,
    StorageCapacity = 0,
    StorageType = "string",
    AutomaticBackupRetentionDays = 0,
    Tags = 
    {
        { "string", "string" },
    },
    WeeklyMaintenanceStartTime = "string",
});

example, err := fsx.NewLustreFileSystem(ctx, "lustreFileSystemResource", &fsx.LustreFileSystemArgs{
	SubnetIds:                     pulumi.String("string"),
	ImportPath:                    pulumi.String("string"),
	DataCompressionType:           pulumi.String("string"),
	ImportedFileChunkSize:         pulumi.Int(0),
	DailyAutomaticBackupStartTime: pulumi.String("string"),
	KmsKeyId:                      pulumi.String("string"),
	DeploymentType:                pulumi.String("string"),
	DriveCacheType:                pulumi.String("string"),
	LogConfiguration: &fsx.LustreFileSystemLogConfigurationArgs{
		Destination: pulumi.String("string"),
		Level:       pulumi.String("string"),
	},
	ExportPath:            pulumi.String("string"),
	FileSystemTypeVersion: pulumi.String("string"),
	FinalBackupTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutoImportPolicy:  pulumi.String("string"),
	CopyTagsToBackups: pulumi.Bool(false),
	BackupId:          pulumi.String("string"),
	EfaEnabled:        pulumi.Bool(false),
	MetadataConfiguration: &fsx.LustreFileSystemMetadataConfigurationArgs{
		Iops: pulumi.Int(0),
		Mode: pulumi.String("string"),
	},
	PerUnitStorageThroughput: pulumi.Int(0),
	RootSquashConfiguration: &fsx.LustreFileSystemRootSquashConfigurationArgs{
		NoSquashNids: pulumi.StringArray{
			pulumi.String("string"),
		},
		RootSquash: pulumi.String("string"),
	},
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SkipFinalBackup:              pulumi.Bool(false),
	StorageCapacity:              pulumi.Int(0),
	StorageType:                  pulumi.String("string"),
	AutomaticBackupRetentionDays: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	WeeklyMaintenanceStartTime: pulumi.String("string"),
})

var lustreFileSystemResource = new LustreFileSystem("lustreFileSystemResource", LustreFileSystemArgs.builder()
    .subnetIds("string")
    .importPath("string")
    .dataCompressionType("string")
    .importedFileChunkSize(0)
    .dailyAutomaticBackupStartTime("string")
    .kmsKeyId("string")
    .deploymentType("string")
    .driveCacheType("string")
    .logConfiguration(LustreFileSystemLogConfigurationArgs.builder()
        .destination("string")
        .level("string")
        .build())
    .exportPath("string")
    .fileSystemTypeVersion("string")
    .finalBackupTags(Map.of("string", "string"))
    .autoImportPolicy("string")
    .copyTagsToBackups(false)
    .backupId("string")
    .efaEnabled(false)
    .metadataConfiguration(LustreFileSystemMetadataConfigurationArgs.builder()
        .iops(0)
        .mode("string")
        .build())
    .perUnitStorageThroughput(0)
    .rootSquashConfiguration(LustreFileSystemRootSquashConfigurationArgs.builder()
        .noSquashNids("string")
        .rootSquash("string")
        .build())
    .securityGroupIds("string")
    .skipFinalBackup(false)
    .storageCapacity(0)
    .storageType("string")
    .automaticBackupRetentionDays(0)
    .tags(Map.of("string", "string"))
    .weeklyMaintenanceStartTime("string")
    .build());

lustre_file_system_resource = aws.fsx.LustreFileSystem("lustreFileSystemResource",
    subnet_ids="string",
    import_path="string",
    data_compression_type="string",
    imported_file_chunk_size=0,
    daily_automatic_backup_start_time="string",
    kms_key_id="string",
    deployment_type="string",
    drive_cache_type="string",
    log_configuration={
        "destination": "string",
        "level": "string",
    },
    export_path="string",
    file_system_type_version="string",
    final_backup_tags={
        "string": "string",
    },
    auto_import_policy="string",
    copy_tags_to_backups=False,
    backup_id="string",
    efa_enabled=False,
    metadata_configuration={
        "iops": 0,
        "mode": "string",
    },
    per_unit_storage_throughput=0,
    root_squash_configuration={
        "no_squash_nids": ["string"],
        "root_squash": "string",
    },
    security_group_ids=["string"],
    skip_final_backup=False,
    storage_capacity=0,
    storage_type="string",
    automatic_backup_retention_days=0,
    tags={
        "string": "string",
    },
    weekly_maintenance_start_time="string")

const lustreFileSystemResource = new aws.fsx.LustreFileSystem("lustreFileSystemResource", {
    subnetIds: "string",
    importPath: "string",
    dataCompressionType: "string",
    importedFileChunkSize: 0,
    dailyAutomaticBackupStartTime: "string",
    kmsKeyId: "string",
    deploymentType: "string",
    driveCacheType: "string",
    logConfiguration: {
        destination: "string",
        level: "string",
    },
    exportPath: "string",
    fileSystemTypeVersion: "string",
    finalBackupTags: {
        string: "string",
    },
    autoImportPolicy: "string",
    copyTagsToBackups: false,
    backupId: "string",
    efaEnabled: false,
    metadataConfiguration: {
        iops: 0,
        mode: "string",
    },
    perUnitStorageThroughput: 0,
    rootSquashConfiguration: {
        noSquashNids: ["string"],
        rootSquash: "string",
    },
    securityGroupIds: ["string"],
    skipFinalBackup: false,
    storageCapacity: 0,
    storageType: "string",
    automaticBackupRetentionDays: 0,
    tags: {
        string: "string",
    },
    weeklyMaintenanceStartTime: "string",
});

type: aws:fsx:LustreFileSystem
properties:
    autoImportPolicy: string
    automaticBackupRetentionDays: 0
    backupId: string
    copyTagsToBackups: false
    dailyAutomaticBackupStartTime: string
    dataCompressionType: string
    deploymentType: string
    driveCacheType: string
    efaEnabled: false
    exportPath: string
    fileSystemTypeVersion: string
    finalBackupTags:
        string: string
    importPath: string
    importedFileChunkSize: 0
    kmsKeyId: string
    logConfiguration:
        destination: string
        level: string
    metadataConfiguration:
        iops: 0
        mode: string
    perUnitStorageThroughput: 0
    rootSquashConfiguration:
        noSquashNids:
            - string
        rootSquash: string
    securityGroupIds:
        - string
    skipFinalBackup: false
    storageCapacity: 0
    storageType: string
    subnetIds: string
    tags:
        string: string
    weeklyMaintenanceStartTime: string

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

SubnetIds string

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

AutoImportPolicy string

How Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. see Auto Import Data Repo for more details. Only supported on PERSISTENT_1 deployment types.

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. only valid for PERSISTENT_1 and PERSISTENT_2 deployment_type.

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. 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. only valid for PERSISTENT_1 and PERSISTENT_2 deployment_type. Requires automatic_backup_retention_days to be set.

DataCompressionType string

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

DeploymentType string

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

DriveCacheType string

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

EfaEnabled bool

Adds support for Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) to Lustre. This must be set at creation. If set this cannot be changed and this prevents changes to per_unit_storage_throughput. This is only supported when deployment_type is set to PERSISTENT_2, metadata_configuration is used, and an EFA-enabled security group is attached.

ExportPath string

S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with import_path argument and the path must use the same Amazon S3 bucket as specified in import_path. Set equal to import_path to overwrite files on export. Defaults to s3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}. Only supported on PERSISTENT_1 deployment types.

FileSystemTypeVersion string

Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for SCRATCH_1, SCRATCH_2 and PERSISTENT_1 deployment types. Valid values for 2.12 include all deployment types.

FinalBackupTags Dictionary<string, string>

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

ImportPath string

S3 URI (with optional prefix) that you're using as the data repository for your FSx for Lustre file system. For example, s3://example-bucket/optional-prefix/. Only supported on PERSISTENT_1 deployment types.

ImportedFileChunkSize int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. Can only be specified with import_path argument. Defaults to 1024. Minimum of 1 and maximum of 512000. Only supported on PERSISTENT_1 deployment types.

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

LogConfiguration LustreFileSystemLogConfiguration

The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs. See log_configuration Block for details.

MetadataConfiguration LustreFileSystemMetadataConfiguration

The Lustre metadata configuration used when creating an Amazon FSx for Lustre file system. This can be used to specify a user provisioned metadata scale. This is only supported when deployment_type is set to PERSISTENT_2. See metadata_configuration Block for details.

PerUnitStorageThroughput int

Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the PERSISTENT_1 and PERSISTENT_2 deployment_type. Valid values for PERSISTENT_1 deployment_type and SSD storage_type are 50, 100, 200. Valid values for PERSISTENT_1 deployment_type and HDD storage_type are 12, 40. Valid values for PERSISTENT_2 deployment_type and SSD storage_type are 125, 250, 500, 1000.

RootSquashConfiguration LustreFileSystemRootSquashConfiguration

The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. See root_squash_configuration Block for details.

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

StorageCapacity int

The storage capacity (GiB) of the file system. Minimum of 1200. See more details at Allowed values for Fsx storage capacity. Update is allowed only for SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup.

StorageType string

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

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.

SubnetIds string

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

AutoImportPolicy string

AutomaticBackupRetentionDays int

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

DailyAutomaticBackupStartTime string

DataCompressionType string

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

DeploymentType string

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

DriveCacheType string

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

EfaEnabled bool

ExportPath string

FileSystemTypeVersion string

FinalBackupTags map[string]string

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

ImportPath string

ImportedFileChunkSize int

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

LogConfiguration LustreFileSystemLogConfigurationArgs

MetadataConfiguration LustreFileSystemMetadataConfigurationArgs

PerUnitStorageThroughput int

RootSquashConfiguration LustreFileSystemRootSquashConfigurationArgs

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

StorageCapacity int

StorageType string

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

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.

subnetIds String

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

autoImportPolicy String

automaticBackupRetentionDays Integer

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

dailyAutomaticBackupStartTime String

dataCompressionType String

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deploymentType String

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

driveCacheType String

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efaEnabled Boolean

exportPath String

fileSystemTypeVersion String

finalBackupTags Map<String,String>

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

importPath String

importedFileChunkSize Integer

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

logConfiguration LustreFileSystemLogConfiguration

metadataConfiguration LustreFileSystemMetadataConfiguration

perUnitStorageThroughput Integer

rootSquashConfiguration LustreFileSystemRootSquashConfiguration

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storageCapacity Integer

storageType String

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

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.

subnetIds string

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

autoImportPolicy string

automaticBackupRetentionDays number

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

dailyAutomaticBackupStartTime string

dataCompressionType string

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deploymentType string

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

driveCacheType string

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efaEnabled boolean

exportPath string

fileSystemTypeVersion string

finalBackupTags {[key: string]: string}

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

importPath string

importedFileChunkSize number

kmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

logConfiguration LustreFileSystemLogConfiguration

metadataConfiguration LustreFileSystemMetadataConfiguration

perUnitStorageThroughput number

rootSquashConfiguration LustreFileSystemRootSquashConfiguration

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storageCapacity number

storageType string

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

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.

subnet_ids str

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

auto_import_policy str

automatic_backup_retention_days int

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

daily_automatic_backup_start_time str

data_compression_type str

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deployment_type str

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

drive_cache_type str

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efa_enabled bool

export_path str

file_system_type_version str

final_backup_tags Mapping[str, str]

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

import_path str

imported_file_chunk_size int

kms_key_id str

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

log_configuration LustreFileSystemLogConfigurationArgs

metadata_configuration LustreFileSystemMetadataConfigurationArgs

per_unit_storage_throughput int

root_squash_configuration LustreFileSystemRootSquashConfigurationArgs

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storage_capacity int

storage_type str

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

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.

subnetIds String

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

autoImportPolicy String

automaticBackupRetentionDays Number

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

dailyAutomaticBackupStartTime String

dataCompressionType String

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deploymentType String

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

driveCacheType String

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efaEnabled Boolean

exportPath String

fileSystemTypeVersion String

finalBackupTags Map<String>

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

importPath String

importedFileChunkSize Number

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

logConfiguration Property Map

metadataConfiguration Property Map

perUnitStorageThroughput Number

rootSquashConfiguration Property Map

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storageCapacity Number

storageType String

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

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 LustreFileSystem 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.
MountName string: The value to be used when mounting the filesystem.
NetworkInterfaceIds List<string>: Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
OwnerId string: AWS account identifier that created the file system.
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.
MountName string: The value to be used when mounting the filesystem.
NetworkInterfaceIds []string: Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
OwnerId string: AWS account identifier that created the file system.
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.
mountName String: The value to be used when mounting the filesystem.
networkInterfaceIds List<String>: Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
ownerId String: AWS account identifier that created the file system.
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.
mountName string: The value to be used when mounting the filesystem.
networkInterfaceIds string[]: Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
ownerId string: AWS account identifier that created the file system.
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.
mount_name str: The value to be used when mounting the filesystem.
network_interface_ids Sequence[str]: Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
owner_id str: AWS account identifier that created the file system.
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.
mountName String: The value to be used when mounting the filesystem.
networkInterfaceIds List<String>: Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
ownerId String: AWS account identifier that created the file system.
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 LustreFileSystem Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auto_import_policy: Optional[str] = None,
        automatic_backup_retention_days: Optional[int] = None,
        backup_id: Optional[str] = None,
        copy_tags_to_backups: Optional[bool] = None,
        daily_automatic_backup_start_time: Optional[str] = None,
        data_compression_type: Optional[str] = None,
        deployment_type: Optional[str] = None,
        dns_name: Optional[str] = None,
        drive_cache_type: Optional[str] = None,
        efa_enabled: Optional[bool] = None,
        export_path: Optional[str] = None,
        file_system_type_version: Optional[str] = None,
        final_backup_tags: Optional[Mapping[str, str]] = None,
        import_path: Optional[str] = None,
        imported_file_chunk_size: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        log_configuration: Optional[LustreFileSystemLogConfigurationArgs] = None,
        metadata_configuration: Optional[LustreFileSystemMetadataConfigurationArgs] = None,
        mount_name: Optional[str] = None,
        network_interface_ids: Optional[Sequence[str]] = None,
        owner_id: Optional[str] = None,
        per_unit_storage_throughput: Optional[int] = None,
        root_squash_configuration: Optional[LustreFileSystemRootSquashConfigurationArgs] = 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,
        vpc_id: Optional[str] = None,
        weekly_maintenance_start_time: Optional[str] = None) -> LustreFileSystem

func GetLustreFileSystem(ctx *Context, name string, id IDInput, state *LustreFileSystemState, opts ...ResourceOption) (*LustreFileSystem, error)

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

public static LustreFileSystem get(String name, Output<String> id, LustreFileSystemState state, CustomResourceOptions options)

resources:  _:    type: aws:fsx:LustreFileSystem    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.

AutoImportPolicy string

AutomaticBackupRetentionDays int

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

DailyAutomaticBackupStartTime string

DataCompressionType string

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

DeploymentType string

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

DnsName string

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

DriveCacheType string

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

EfaEnabled bool

ExportPath string

FileSystemTypeVersion string

FinalBackupTags Dictionary<string, string>

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

ImportPath string

ImportedFileChunkSize int

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

LogConfiguration LustreFileSystemLogConfiguration

MetadataConfiguration LustreFileSystemMetadataConfiguration

MountName string

The value to be used when mounting the filesystem.

NetworkInterfaceIds List<string>

Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.

OwnerId string

AWS account identifier that created the file system.

PerUnitStorageThroughput int

RootSquashConfiguration LustreFileSystemRootSquashConfiguration

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

StorageCapacity int

StorageType string

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

SubnetIds string

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

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.

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.

AutoImportPolicy string

AutomaticBackupRetentionDays int

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

DailyAutomaticBackupStartTime string

DataCompressionType string

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

DeploymentType string

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

DnsName string

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

DriveCacheType string

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

EfaEnabled bool

ExportPath string

FileSystemTypeVersion string

FinalBackupTags map[string]string

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

ImportPath string

ImportedFileChunkSize int

KmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

LogConfiguration LustreFileSystemLogConfigurationArgs

MetadataConfiguration LustreFileSystemMetadataConfigurationArgs

MountName string

The value to be used when mounting the filesystem.

NetworkInterfaceIds []string

Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.

OwnerId string

AWS account identifier that created the file system.

PerUnitStorageThroughput int

RootSquashConfiguration LustreFileSystemRootSquashConfigurationArgs

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

StorageCapacity int

StorageType string

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

SubnetIds string

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

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.

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.

autoImportPolicy String

automaticBackupRetentionDays Integer

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

dailyAutomaticBackupStartTime String

dataCompressionType String

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deploymentType String

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

dnsName String

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

driveCacheType String

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efaEnabled Boolean

exportPath String

fileSystemTypeVersion String

finalBackupTags Map<String,String>

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

importPath String

importedFileChunkSize Integer

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

logConfiguration LustreFileSystemLogConfiguration

metadataConfiguration LustreFileSystemMetadataConfiguration

mountName String

The value to be used when mounting the filesystem.

networkInterfaceIds List<String>

Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.

ownerId String

AWS account identifier that created the file system.

perUnitStorageThroughput Integer

rootSquashConfiguration LustreFileSystemRootSquashConfiguration

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storageCapacity Integer

storageType String

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

subnetIds String

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

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.

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.

autoImportPolicy string

automaticBackupRetentionDays number

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

dailyAutomaticBackupStartTime string

dataCompressionType string

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deploymentType string

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

dnsName string

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

driveCacheType string

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efaEnabled boolean

exportPath string

fileSystemTypeVersion string

finalBackupTags {[key: string]: string}

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

importPath string

importedFileChunkSize number

kmsKeyId string

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

logConfiguration LustreFileSystemLogConfiguration

metadataConfiguration LustreFileSystemMetadataConfiguration

mountName string

The value to be used when mounting the filesystem.

networkInterfaceIds string[]

Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.

ownerId string

AWS account identifier that created the file system.

perUnitStorageThroughput number

rootSquashConfiguration LustreFileSystemRootSquashConfiguration

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storageCapacity number

storageType string

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

subnetIds string

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

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.

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.

auto_import_policy str

automatic_backup_retention_days int

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

daily_automatic_backup_start_time str

data_compression_type str

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deployment_type str

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

dns_name str

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

drive_cache_type str

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efa_enabled bool

export_path str

file_system_type_version str

final_backup_tags Mapping[str, str]

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

import_path str

imported_file_chunk_size int

kms_key_id str

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

log_configuration LustreFileSystemLogConfigurationArgs

metadata_configuration LustreFileSystemMetadataConfigurationArgs

mount_name str

The value to be used when mounting the filesystem.

network_interface_ids Sequence[str]

Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.

owner_id str

AWS account identifier that created the file system.

per_unit_storage_throughput int

root_squash_configuration LustreFileSystemRootSquashConfigurationArgs

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storage_capacity int

storage_type str

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

subnet_ids str

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

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.

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.

autoImportPolicy String

automaticBackupRetentionDays Number

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. Applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. The default value is false.

dailyAutomaticBackupStartTime String

dataCompressionType String

Sets the data compression configuration for the file system. Valid values are LZ4 and NONE. Default value is NONE. Unsetting this value reverts the compression type back to NONE.

deploymentType String

The filesystem deployment type. One of: SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2.

dnsName String

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

driveCacheType String

The type of drive cache used by PERSISTENT_1 filesystems that are provisioned with HDD storage_type. Required for HDD storage_type, set to either READ or NONE.

efaEnabled Boolean

exportPath String

fileSystemTypeVersion String

finalBackupTags Map<String>

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

importPath String

importedFileChunkSize Number

kmsKeyId String

ARN for the KMS Key to encrypt the file system at rest, applicable for PERSISTENT_1 and PERSISTENT_2 deployment_type. Defaults to an AWS managed KMS Key.

logConfiguration Property Map

metadataConfiguration Property Map

mountName String

The value to be used when mounting the filesystem.

networkInterfaceIds List<String>

Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.

ownerId String

AWS account identifier that created the file system.

perUnitStorageThroughput Number

rootSquashConfiguration Property Map

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

Note: If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set.

storageCapacity Number

storageType String

The filesystem storage type. Either SSD or HDD, defaults to SSD. HDD is only supported on PERSISTENT_1 deployment types.

subnetIds String

A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.

The following arguments are optional:

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.

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

LustreFileSystemLogConfiguration, LustreFileSystemLogConfigurationArgs

Destination string: The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group.
Level string: Sets which data repository events are logged by Amazon FSx. Valid values are WARN_ONLY, FAILURE_ONLY, ERROR_ONLY, WARN_ERROR and DISABLED. Default value is DISABLED.

Destination string: The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group.
Level string: Sets which data repository events are logged by Amazon FSx. Valid values are WARN_ONLY, FAILURE_ONLY, ERROR_ONLY, WARN_ERROR and DISABLED. Default value is DISABLED.

destination String: The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group.
level String: Sets which data repository events are logged by Amazon FSx. Valid values are WARN_ONLY, FAILURE_ONLY, ERROR_ONLY, WARN_ERROR and DISABLED. Default value is DISABLED.

destination string: The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group.
level string: Sets which data repository events are logged by Amazon FSx. Valid values are WARN_ONLY, FAILURE_ONLY, ERROR_ONLY, WARN_ERROR and DISABLED. Default value is DISABLED.

destination str: The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group.
level str: Sets which data repository events are logged by Amazon FSx. Valid values are WARN_ONLY, FAILURE_ONLY, ERROR_ONLY, WARN_ERROR and DISABLED. Default value is DISABLED.

destination String: The Amazon Resource Name (ARN) that specifies the destination of the logs. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group.
level String: Sets which data repository events are logged by Amazon FSx. Valid values are WARN_ONLY, FAILURE_ONLY, ERROR_ONLY, WARN_ERROR and DISABLED. Default value is DISABLED.

LustreFileSystemMetadataConfiguration, LustreFileSystemMetadataConfigurationArgs

Iops int

Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to USER_PROVISIONED. Valid Values are 1500,3000,6000 and 12000 through 192000 in increments of 12000.

Mode string

Mode for the metadata configuration of the file system. Valid values are AUTOMATIC, and USER_PROVISIONED.

!> WARNING: Updating the value of iops from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.

Iops int

Mode string

Mode for the metadata configuration of the file system. Valid values are AUTOMATIC, and USER_PROVISIONED.

!> WARNING: Updating the value of iops from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.

iops Integer

mode String

Mode for the metadata configuration of the file system. Valid values are AUTOMATIC, and USER_PROVISIONED.

!> WARNING: Updating the value of iops from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.

iops number

mode string

Mode for the metadata configuration of the file system. Valid values are AUTOMATIC, and USER_PROVISIONED.

!> WARNING: Updating the value of iops from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.

iops int

mode str

Mode for the metadata configuration of the file system. Valid values are AUTOMATIC, and USER_PROVISIONED.

!> WARNING: Updating the value of iops from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.

iops Number

mode String

Mode for the metadata configuration of the file system. Valid values are AUTOMATIC, and USER_PROVISIONED.

!> WARNING: Updating the value of iops from a higher to a lower value will force a recreation of the resource. Any data on the file system will be lost when recreating.

LustreFileSystemRootSquashConfiguration, LustreFileSystemRootSquashConfigurationArgs

NoSquashNids List<string>: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
RootSquash string: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.

NoSquashNids []string: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
RootSquash string: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.

noSquashNids List<String>: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
rootSquash String: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.

noSquashNids string[]: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
rootSquash string: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.

no_squash_nids Sequence[str]: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
root_squash str: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.

noSquashNids List<String>: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
rootSquash String: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294.

Import

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

$ pulumi import aws:fsx/lustreFileSystem:LustreFileSystem 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.LustreFileSystem

On this page

On this page

Example Usage

Create LustreFileSystem Resource

Constructor syntax

Parameters

Constructor example

LustreFileSystem Resource Properties

Inputs

Outputs

Look up Existing LustreFileSystem Resource

Supporting Types

LustreFileSystemLogConfiguration, LustreFileSystemLogConfigurationArgs

LustreFileSystemMetadataConfiguration, LustreFileSystemMetadataConfigurationArgs

LustreFileSystemRootSquashConfiguration, LustreFileSystemRootSquashConfigurationArgs

Import

Package Details

On this page

On this page