LustreFileSystem class
Manages a FSx Lustre File System. See the FSx Lustre Guide for more information.
> NOTE: autoImportPolicy, exportPath, importPath and importedFileChunkSize are not supported with the PERSISTENT_2 deployment type. Use aws.fsx.DataRepositoryAssociation instead.
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"])
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_fsx_lustrefilesystem" "example" {
import_path ="s3://${exampleAwsS3Bucket.bucket}"
storage_capacity = 1200
subnet_ids = 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.ArrayList;
import java.util.Arrays;
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}
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 securityGroupIds, 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 ignoreChanges to hide the difference. For example:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.fsx.LustreFileSystem("example", {securityGroupIds: [exampleAwsSecurityGroup.id]}, {
ignoreChanges: ["securityGroupIds"],
});
import pulumi
import pulumi_aws as aws
example = aws.fsx.LustreFileSystem("example", security_group_ids=[example_aws_security_group["id"]],
opts = pulumi.ResourceOptions(ignore_changes=["securityGroupIds"]))
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()
{
SecurityGroupIds = new[]
{
exampleAwsSecurityGroup.Id,
},
}, new CustomResourceOptions
{
IgnoreChanges =
{
"securityGroupIds",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
SecurityGroupIds: pulumi.StringArray{
exampleAwsSecurityGroup.Id,
},
}, pulumi.IgnoreChanges([]string{
"securityGroupIds",
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_fsx_lustrefilesystem" "example" {
lifecycle {
ignore_changes = [securityGroupIds]
}
security_group_ids = [exampleAwsSecurityGroup.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 com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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()
.securityGroupIds(exampleAwsSecurityGroup.id())
.build(), CustomResourceOptions.builder()
.ignoreChanges("securityGroupIds")
.build());
}
}
resources:
example:
type: aws:fsx:LustreFileSystem
properties:
securityGroupIds:
- ${exampleAwsSecurityGroup.id}
options:
ignoreChanges:
- securityGroupIds
Constructors
- LustreFileSystem(String name, {LustreFileSystemArgs? args, CustomResourceOptions? options})
-
Creates a new LustreFileSystem.
nameThe Pulumi resource name.argsArguments used to configure this LustreFileSystem. The set of arguments for LustreFileSystem.optionsResource options controlling this resource's behavior. - LustreFileSystem.reference(String urn)
- Creates a typed reference to an existing LustreFileSystem resource.
Properties
-
arn
↔ Output<
String> -
ARN of the file system.
latefinal
-
autoImportPolicy
↔ Output<
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_1deployment types.latefinal -
automaticBackupRetentionDays
↔ Output<
int> -
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_1andPERSISTENT_2deployment_type.latefinal -
backupId
↔ Output<
String?> -
ID of the source backup to create the filesystem from.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
copyTagsToBackups
↔ Output<
bool?> -
Whether to copy tags for the file system to backups. Applicable for
PERSISTENT_1andPERSISTENT_2deployment_type. The default value is false.latefinal -
dailyAutomaticBackupStartTime
↔ Output<
String> -
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_1andPERSISTENT_2deployment_type. RequiresautomaticBackupRetentionDaysto be set.latefinal -
dataCompressionType
↔ Output<
String?> -
Sets the data compression configuration for the file system. Valid values are
LZ4andNONE. Default value isNONE. Unsetting this value reverts the compression type back toNONE.latefinal -
dataReadCacheConfiguration
↔ Output<
LustreFileSystemDataReadCacheConfiguration?> -
latefinal
-
deploymentType
↔ Output<
String?> -
Filesystem deployment type. One of:
SCRATCH_1,SCRATCH_2,PERSISTENT_1,PERSISTENT_2.latefinal -
dnsName
↔ Output<
String> -
DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.comlatefinal -
driveCacheType
↔ Output<
String?> -
Type of drive cache used by
PERSISTENT_1filesystems that are provisioned withHDDstorage_type. Required forHDDstorage_type, set to eitherREADorNONE.latefinal -
efaEnabled
↔ Output<
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
perUnitStorageThroughput. This is only supported when deploymentType is set toPERSISTENT_2,metadataConfigurationis used, and an EFA-enabled security group is attached.latefinal -
exportPath
↔ Output<
String> -
S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with
importPathargument and the path must use the same Amazon S3 bucket as specified inimportPath. Set equal toimportPathto overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}. Only supported onPERSISTENT_1deployment types.latefinal -
fileSystemTypeVersion
↔ Output<
String> -
Sets the Lustre version for the file system. Valid values are
2.10,2.12, and2.15. When creating a file system,2.10is valid forSCRATCH_1,SCRATCH_2, andPERSISTENT_1deployment types;2.12and2.15are valid for all deployment types. Changing this value to a higher version triggers an in-place upgrade. Changing to a lower version forces resource replacement (destroy and recreate).latefinal -
finalBackupTags
↔ Output<
Map< String, String> ?> -
Map of tags to apply to the file system's final backup.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
importedFileChunkSize
↔ Output<
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
importPathargument. Defaults to1024. Minimum of1and maximum of512000. Only supported onPERSISTENT_1deployment types.latefinal -
importPath
↔ Output<
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 onPERSISTENT_1deployment types.latefinal - isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyId
↔ Output<
String> -
ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1andPERSISTENT_2deployment_type. Defaults to an AWS managed KMS Key.latefinal -
logConfiguration
↔ Output<
LustreFileSystemLogConfiguration> -
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
logConfigurationBlock for details.latefinal -
metadataConfiguration
↔ Output<
LustreFileSystemMetadataConfiguration> -
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
deploymentTypeis set toPERSISTENT_2. SeemetadataConfigurationBlock for details.latefinal -
mountName
↔ Output<
String> -
Value to be used when mounting the filesystem.
latefinal
-
networkInterfaceIds
↔ Output<
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.
latefinal
-
ownerId
↔ Output<
String> -
AWS account identifier that created the file system.
latefinal
-
perUnitStorageThroughput
↔ Output<
int?> -
Amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1andPERSISTENT_2deployment_type. Valid values forPERSISTENT_1deploymentType andSSDstorageType are 50, 100, 200. Valid values forPERSISTENT_1deploymentType andHDDstorageType are 12, 40. Valid values forPERSISTENT_2deploymentType andSSDstorageType are 125, 250, 500, 1000.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
rootSquashConfiguration
↔ Output<
LustreFileSystemRootSquashConfiguration?> -
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
rootSquashConfigurationBlock for details.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroupIds
↔ Output<
List< String> ?> -
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.
latefinal
-
skipFinalBackup
↔ Output<
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.latefinal -
storageCapacity
↔ Output<
int?> -
Storage capacity (GiB) of the file system. Minimum of
1200. See more details at Allowed values for Fsx storage capacity. Update is allowed only forSCRATCH_2,PERSISTENT_1andPERSISTENT_2deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup.latefinal -
storageType
↔ Output<
String?> -
Filesystem storage type. One of
SSD,HDDorINTELLIGENT_TIERING, defaults toSSD.HDDis only supported onPERSISTENT_1deployment types.INTELLIGENT_TIERINGrequiresdataReadCacheConfigurationandmetadataConfigurationto be set and is only supported forPERSISTENT_2deployment types.latefinal -
subnetIds
↔ Output<
String> -
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.
latefinal
-
Map of tags to assign to the file system. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
throughputCapacity
↔ Output<
int?> -
Throughput in MBps required for the
INTELLIGENT_TIERINGstorage type. Must be 4000 or multiples of 4000.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcId
↔ Output<
String> -
Identifier of the VPC for the file system.
latefinal
-
weeklyMaintenanceStartTime
↔ Output<
String> -
Preferred start time (in
d:HH:MMformat) to perform weekly maintenance, in the UTC time zone.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {LustreFileSystemState? state, CustomResourceOptions? options}) → LustreFileSystem -
Gets an existing LustreFileSystem resource's state with the given
nameandid.