LustreFileSystem

Manages a FSx Lustre File System. See the FSx Lustre Guide for more information.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Fsx.LustreFileSystem("example", new Aws.Fsx.LustreFileSystemArgs
        {
            ImportPath = $"s3://{aws_s3_bucket.Example.Bucket}",
            StorageCapacity = 1200,
            SubnetIds = aws_subnet.Example.Id,
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/fsx"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := fsx.NewLustreFileSystem(ctx, "example", &fsx.LustreFileSystemArgs{
            ImportPath:      pulumi.String(fmt.Sprintf("%v%v", "s3://", aws_s3_bucket.Example.Bucket)),
            StorageCapacity: pulumi.Int(1200),
            SubnetIds:       pulumi.String(aws_subnet.Example.Id),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

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

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

const example = new aws.fsx.LustreFileSystem("example", {
    importPath: pulumi.interpolate`s3://${aws_s3_bucket_example.bucket}`,
    storageCapacity: 1200,
    subnetIds: aws_subnet_example.id,
});

Create a LustreFileSystem Resource

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

def LustreFileSystem(resource_name, opts=None, export_path=None, import_path=None, imported_file_chunk_size=None, security_group_ids=None, storage_capacity=None, subnet_ids=None, tags=None, weekly_maintenance_start_time=None, __props__=None);

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

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

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.
opts ResourceOptions: A bag of options that control this 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.

LustreFileSystem Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The LustreFileSystem resource accepts the following input properties:

StorageCapacity int: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
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}.
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/.
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.
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.
Tags Dictionary<string, string>: A map of tags to assign to the file system.
WeeklyMaintenanceStartTime string: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

StorageCapacity int: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
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}.
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/.
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.
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.
Tags map[string]string: A map of tags to assign to the file system.
WeeklyMaintenanceStartTime string: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

storageCapacity number: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
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}.
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/.
importedFileChunkSize number: 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.
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.
tags {[key: string]: string}: A map of tags to assign to the file system.
weeklyMaintenanceStartTime string: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

storage_capacity float: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
export_path str: 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}.
import_path str: 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/.
imported_file_chunk_size float: 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.
security_group_ids List[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.
tags Dict[str, str]: A map of tags to assign to 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.

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.
NetworkInterfaceIds List<string>: Set of Elastic Network Interface identifiers from which the file system is accessible.
OwnerId string: AWS account identifier that created the file system.
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.
OwnerId string: AWS account identifier that created the file system.
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.
ownerId string: AWS account identifier that created the file system.
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 List[str]: Set of Elastic Network Interface identifiers from which the file system is accessible.
owner_id str: AWS account identifier that created the file system.
vpc_id str: Identifier of the Virtual Private Cloud for the file system.

Look up an 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

static get(resource_name, id, opts=None, arn=None, dns_name=None, export_path=None, import_path=None, imported_file_chunk_size=None, network_interface_ids=None, owner_id=None, security_group_ids=None, storage_capacity=None, subnet_ids=None, tags=None, vpc_id=None, weekly_maintenance_start_time=None, __props__=None);

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)

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.

The following state arguments are supported:

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
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}.
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/.
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.
NetworkInterfaceIds List<string>: Set of Elastic Network Interface identifiers from which the file system is accessible.
OwnerId string: AWS account identifier that created the file system.
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.
StorageCapacity int: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
Tags Dictionary<string, string>: A map of tags to assign to the file system.
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.
DnsName string: DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com
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}.
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/.
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.
NetworkInterfaceIds []string: Set of Elastic Network Interface identifiers from which the file system is accessible.
OwnerId string: AWS account identifier that created the file system.
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.
StorageCapacity int: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
Tags map[string]string: A map of tags to assign to the file system.
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.
dnsName string: DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com
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}.
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/.
importedFileChunkSize number: 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.
networkInterfaceIds string[]: Set of Elastic Network Interface identifiers from which the file system is accessible.
ownerId string: AWS account identifier that created the file system.
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.
storageCapacity number: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
tags {[key: string]: string}: A map of tags to assign to the file system.
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.
dns_name str: DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com
export_path str: 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}.
import_path str: 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/.
imported_file_chunk_size float: 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.
network_interface_ids List[str]: Set of Elastic Network Interface identifiers from which the file system is accessible.
owner_id str: AWS account identifier that created the file system.
security_group_ids List[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.
storage_capacity float: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
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.
tags Dict[str, str]: A map of tags to assign to the file system.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud