aws.fsx.LustreFileSystem
Explore with Pulumi AI
Manages a FSx Lustre File System. See the FSx Lustre Guide for more information.
NOTE:
auto_import_policy
,export_path
,import_path
andimported_file_chunk_size
are not supported with thePERSISTENT_2
deployment type. Useaws.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"])
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,
imported_file_chunk_size: Optional[int] = None,
automatic_backup_retention_days: Optional[int] = 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,
drive_cache_type: Optional[str] = None,
export_path: Optional[str] = None,
file_system_type_version: Optional[str] = None,
final_backup_tags: Optional[Mapping[str, str]] = None,
weekly_maintenance_start_time: Optional[str] = None,
backup_id: Optional[str] = None,
metadata_configuration: Optional[LustreFileSystemMetadataConfigurationArgs] = None,
log_configuration: Optional[LustreFileSystemLogConfigurationArgs] = None,
kms_key_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,
auto_import_policy: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
import_path: 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",
ImportedFileChunkSize = 0,
AutomaticBackupRetentionDays = 0,
CopyTagsToBackups = false,
DailyAutomaticBackupStartTime = "string",
DataCompressionType = "string",
DeploymentType = "string",
DriveCacheType = "string",
ExportPath = "string",
FileSystemTypeVersion = "string",
FinalBackupTags =
{
{ "string", "string" },
},
WeeklyMaintenanceStartTime = "string",
BackupId = "string",
MetadataConfiguration = new Aws.Fsx.Inputs.LustreFileSystemMetadataConfigurationArgs
{
Iops = 0,
Mode = "string",
},
LogConfiguration = new Aws.Fsx.Inputs.LustreFileSystemLogConfigurationArgs
{
Destination = "string",
Level = "string",
},
KmsKeyId = "string",
PerUnitStorageThroughput = 0,
RootSquashConfiguration = new Aws.Fsx.Inputs.LustreFileSystemRootSquashConfigurationArgs
{
NoSquashNids = new[]
{
"string",
},
RootSquash = "string",
},
SecurityGroupIds = new[]
{
"string",
},
SkipFinalBackup = false,
StorageCapacity = 0,
StorageType = "string",
AutoImportPolicy = "string",
Tags =
{
{ "string", "string" },
},
ImportPath = "string",
});
example, err := fsx.NewLustreFileSystem(ctx, "lustreFileSystemResource", &fsx.LustreFileSystemArgs{
SubnetIds: pulumi.String("string"),
ImportedFileChunkSize: pulumi.Int(0),
AutomaticBackupRetentionDays: pulumi.Int(0),
CopyTagsToBackups: pulumi.Bool(false),
DailyAutomaticBackupStartTime: pulumi.String("string"),
DataCompressionType: pulumi.String("string"),
DeploymentType: pulumi.String("string"),
DriveCacheType: pulumi.String("string"),
ExportPath: pulumi.String("string"),
FileSystemTypeVersion: pulumi.String("string"),
FinalBackupTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
WeeklyMaintenanceStartTime: pulumi.String("string"),
BackupId: pulumi.String("string"),
MetadataConfiguration: &fsx.LustreFileSystemMetadataConfigurationArgs{
Iops: pulumi.Int(0),
Mode: pulumi.String("string"),
},
LogConfiguration: &fsx.LustreFileSystemLogConfigurationArgs{
Destination: pulumi.String("string"),
Level: pulumi.String("string"),
},
KmsKeyId: 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"),
AutoImportPolicy: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ImportPath: pulumi.String("string"),
})
var lustreFileSystemResource = new LustreFileSystem("lustreFileSystemResource", LustreFileSystemArgs.builder()
.subnetIds("string")
.importedFileChunkSize(0)
.automaticBackupRetentionDays(0)
.copyTagsToBackups(false)
.dailyAutomaticBackupStartTime("string")
.dataCompressionType("string")
.deploymentType("string")
.driveCacheType("string")
.exportPath("string")
.fileSystemTypeVersion("string")
.finalBackupTags(Map.of("string", "string"))
.weeklyMaintenanceStartTime("string")
.backupId("string")
.metadataConfiguration(LustreFileSystemMetadataConfigurationArgs.builder()
.iops(0)
.mode("string")
.build())
.logConfiguration(LustreFileSystemLogConfigurationArgs.builder()
.destination("string")
.level("string")
.build())
.kmsKeyId("string")
.perUnitStorageThroughput(0)
.rootSquashConfiguration(LustreFileSystemRootSquashConfigurationArgs.builder()
.noSquashNids("string")
.rootSquash("string")
.build())
.securityGroupIds("string")
.skipFinalBackup(false)
.storageCapacity(0)
.storageType("string")
.autoImportPolicy("string")
.tags(Map.of("string", "string"))
.importPath("string")
.build());
lustre_file_system_resource = aws.fsx.LustreFileSystem("lustreFileSystemResource",
subnet_ids="string",
imported_file_chunk_size=0,
automatic_backup_retention_days=0,
copy_tags_to_backups=False,
daily_automatic_backup_start_time="string",
data_compression_type="string",
deployment_type="string",
drive_cache_type="string",
export_path="string",
file_system_type_version="string",
final_backup_tags={
"string": "string",
},
weekly_maintenance_start_time="string",
backup_id="string",
metadata_configuration={
"iops": 0,
"mode": "string",
},
log_configuration={
"destination": "string",
"level": "string",
},
kms_key_id="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",
auto_import_policy="string",
tags={
"string": "string",
},
import_path="string")
const lustreFileSystemResource = new aws.fsx.LustreFileSystem("lustreFileSystemResource", {
subnetIds: "string",
importedFileChunkSize: 0,
automaticBackupRetentionDays: 0,
copyTagsToBackups: false,
dailyAutomaticBackupStartTime: "string",
dataCompressionType: "string",
deploymentType: "string",
driveCacheType: "string",
exportPath: "string",
fileSystemTypeVersion: "string",
finalBackupTags: {
string: "string",
},
weeklyMaintenanceStartTime: "string",
backupId: "string",
metadataConfiguration: {
iops: 0,
mode: "string",
},
logConfiguration: {
destination: "string",
level: "string",
},
kmsKeyId: "string",
perUnitStorageThroughput: 0,
rootSquashConfiguration: {
noSquashNids: ["string"],
rootSquash: "string",
},
securityGroupIds: ["string"],
skipFinalBackup: false,
storageCapacity: 0,
storageType: "string",
autoImportPolicy: "string",
tags: {
string: "string",
},
importPath: "string",
});
type: aws:fsx:LustreFileSystem
properties:
autoImportPolicy: string
automaticBackupRetentionDays: 0
backupId: string
copyTagsToBackups: false
dailyAutomaticBackupStartTime: string
dataCompressionType: string
deploymentType: string
driveCacheType: string
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:
- Subnet
Ids 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:
- Auto
Import stringPolicy - 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. - Automatic
Backup intRetention Days - 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
andPERSISTENT_2
deployment_type. - Backup
Id string - The ID of the source backup to create the filesystem from.
- bool
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - Daily
Automatic stringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - Data
Compression stringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - Deployment
Type string - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - Drive
Cache stringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - Export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - File
System stringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- Import
Path 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_1
deployment types. - Imported
File intChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - Kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - Log
Configuration LustreFile System Log Configuration - 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. - Metadata
Configuration LustreFile System Metadata Configuration - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - Per
Unit intStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - Root
Squash LustreConfiguration File System Root Squash Configuration - 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. - Security
Group List<string>Ids - 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 boolBackup 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.
- Storage
Capacity 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - Storage
Type string - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - 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. - Weekly
Maintenance stringStart Time - The preferred start time (in
d:HH:MM
format) to perform weekly maintenance, in the UTC time zone.
- Subnet
Ids 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:
- Auto
Import stringPolicy - 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. - Automatic
Backup intRetention Days - 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
andPERSISTENT_2
deployment_type. - Backup
Id string - The ID of the source backup to create the filesystem from.
- bool
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - Daily
Automatic stringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - Data
Compression stringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - Deployment
Type string - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - Drive
Cache stringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - Export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - File
System stringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- Import
Path 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_1
deployment types. - Imported
File intChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - Kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - Log
Configuration LustreFile System Log Configuration Args - 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. - Metadata
Configuration LustreFile System Metadata Configuration Args - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - Per
Unit intStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - Root
Squash LustreConfiguration File System Root Squash Configuration Args - 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. - Security
Group []stringIds - 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 boolBackup 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.
- Storage
Capacity 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - Storage
Type string - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - 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. - Weekly
Maintenance stringStart Time - The preferred start time (in
d:HH:MM
format) to perform weekly maintenance, in the UTC time zone.
- subnet
Ids 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:
- auto
Import StringPolicy - 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. - automatic
Backup IntegerRetention Days - 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
andPERSISTENT_2
deployment_type. - backup
Id String - The ID of the source backup to create the filesystem from.
- Boolean
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily
Automatic StringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data
Compression StringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment
Type String - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - drive
Cache StringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file
System StringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- import
Path 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_1
deployment types. - imported
File IntegerChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms
Key StringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log
Configuration LustreFile System Log Configuration - 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. - metadata
Configuration LustreFile System Metadata Configuration - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - per
Unit IntegerStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root
Squash LustreConfiguration File System Root Squash Configuration - 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. - security
Group List<String>Ids - 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 BooleanBackup 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.
- storage
Capacity Integer - 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage
Type String - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - 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. - weekly
Maintenance StringStart Time - The preferred start time (in
d:HH:MM
format) to perform weekly maintenance, in the UTC time zone.
- subnet
Ids 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:
- auto
Import stringPolicy - 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. - automatic
Backup numberRetention Days - 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
andPERSISTENT_2
deployment_type. - backup
Id string - The ID of the source backup to create the filesystem from.
- boolean
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily
Automatic stringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data
Compression stringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment
Type string - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - drive
Cache stringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file
System stringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - {[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.
- import
Path 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_1
deployment types. - imported
File numberChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log
Configuration LustreFile System Log Configuration - 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. - metadata
Configuration LustreFile System Metadata Configuration - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - per
Unit numberStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root
Squash LustreConfiguration File System Root Squash Configuration - 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. - security
Group string[]Ids - 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 booleanBackup 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.
- storage
Capacity number - 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage
Type string - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - {[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. - weekly
Maintenance stringStart Time - 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_ strpolicy - 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. - automatic_
backup_ intretention_ days - 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
andPERSISTENT_2
deployment_type. - backup_
id str - The ID of the source backup to create the filesystem from.
- bool
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily_
automatic_ strbackup_ start_ time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data_
compression_ strtype - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment_
type str - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - drive_
cache_ strtype - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file_
system_ strtype_ version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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 - 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_1
deployment types. - imported_
file_ intchunk_ size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms_
key_ strid - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log_
configuration LustreFile System Log Configuration Args - 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. - metadata_
configuration LustreFile System Metadata Configuration Args - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - per_
unit_ intstorage_ throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root_
squash_ Lustreconfiguration File System Root Squash Configuration Args - 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. - security_
group_ Sequence[str]ids - 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_ boolbackup 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.
- storage_
capacity 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage_
type str - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - 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_ strstart_ time - The preferred start time (in
d:HH:MM
format) to perform weekly maintenance, in the UTC time zone.
- subnet
Ids 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:
- auto
Import StringPolicy - 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. - automatic
Backup NumberRetention Days - 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
andPERSISTENT_2
deployment_type. - backup
Id String - The ID of the source backup to create the filesystem from.
- Boolean
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily
Automatic StringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data
Compression StringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment
Type String - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - drive
Cache StringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file
System StringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- import
Path 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_1
deployment types. - imported
File NumberChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms
Key StringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log
Configuration Property Map - 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. - metadata
Configuration Property Map - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - per
Unit NumberStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root
Squash Property MapConfiguration - 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. - security
Group List<String>Ids - 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 BooleanBackup 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.
- storage
Capacity Number - 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage
Type String - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - 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. - weekly
Maintenance StringStart Time - 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.
- Dns
Name 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.
- Mount
Name string - The value to be used when mounting the filesystem.
- Network
Interface List<string>Ids - 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 string - AWS account identifier that created the file system.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Id string - Identifier of the Virtual Private Cloud for the file system.
- Arn string
- Amazon Resource Name of the file system.
- Dns
Name 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.
- Mount
Name string - The value to be used when mounting the filesystem.
- Network
Interface []stringIds - 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 string - AWS account identifier that created the file system.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Id string - Identifier of the Virtual Private Cloud for the file system.
- arn String
- Amazon Resource Name of the file system.
- dns
Name 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.
- mount
Name String - The value to be used when mounting the filesystem.
- network
Interface List<String>Ids - 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 String - AWS account identifier that created the file system.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id String - Identifier of the Virtual Private Cloud for the file system.
- arn string
- Amazon Resource Name of the file system.
- dns
Name 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.
- mount
Name string - The value to be used when mounting the filesystem.
- network
Interface string[]Ids - 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 string - AWS account identifier that created the file system.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id 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_ Sequence[str]ids - 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.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc_
id str - Identifier of the Virtual Private Cloud for the file system.
- arn String
- Amazon Resource Name of the file system.
- dns
Name 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.
- mount
Name String - The value to be used when mounting the filesystem.
- network
Interface List<String>Ids - 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 String - AWS account identifier that created the file system.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id 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,
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- Amazon Resource Name of the file system.
- Auto
Import stringPolicy - 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. - Automatic
Backup intRetention Days - 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
andPERSISTENT_2
deployment_type. - Backup
Id string - The ID of the source backup to create the filesystem from.
- bool
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - Daily
Automatic stringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - Data
Compression stringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - Deployment
Type string - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - Dns
Name string - DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.com
- Drive
Cache stringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - Export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - File
System stringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- Import
Path 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_1
deployment types. - Imported
File intChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - Kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - Log
Configuration LustreFile System Log Configuration - 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. - Metadata
Configuration LustreFile System Metadata Configuration - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - Mount
Name string - The value to be used when mounting the filesystem.
- Network
Interface List<string>Ids - 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 string - AWS account identifier that created the file system.
- Per
Unit intStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - Root
Squash LustreConfiguration File System Root Squash Configuration - 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. - Security
Group List<string>Ids - 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 boolBackup 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.
- Storage
Capacity 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - Storage
Type string - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - Subnet
Ids 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:
- 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Id string - Identifier of the Virtual Private Cloud for the file system.
- Weekly
Maintenance stringStart Time - 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.
- Auto
Import stringPolicy - 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. - Automatic
Backup intRetention Days - 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
andPERSISTENT_2
deployment_type. - Backup
Id string - The ID of the source backup to create the filesystem from.
- bool
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - Daily
Automatic stringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - Data
Compression stringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - Deployment
Type string - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - Dns
Name string - DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.com
- Drive
Cache stringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - Export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - File
System stringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- Import
Path 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_1
deployment types. - Imported
File intChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - Kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - Log
Configuration LustreFile System Log Configuration Args - 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. - Metadata
Configuration LustreFile System Metadata Configuration Args - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - Mount
Name string - The value to be used when mounting the filesystem.
- Network
Interface []stringIds - 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 string - AWS account identifier that created the file system.
- Per
Unit intStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - Root
Squash LustreConfiguration File System Root Squash Configuration Args - 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. - Security
Group []stringIds - 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 boolBackup 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.
- Storage
Capacity 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - Storage
Type string - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - Subnet
Ids 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:
- 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Id string - Identifier of the Virtual Private Cloud for the file system.
- Weekly
Maintenance stringStart Time - 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.
- auto
Import StringPolicy - 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. - automatic
Backup IntegerRetention Days - 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
andPERSISTENT_2
deployment_type. - backup
Id String - The ID of the source backup to create the filesystem from.
- Boolean
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily
Automatic StringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data
Compression StringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment
Type String - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - dns
Name String - DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.com
- drive
Cache StringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file
System StringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- import
Path 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_1
deployment types. - imported
File IntegerChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms
Key StringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log
Configuration LustreFile System Log Configuration - 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. - metadata
Configuration LustreFile System Metadata Configuration - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - mount
Name String - The value to be used when mounting the filesystem.
- network
Interface List<String>Ids - 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 String - AWS account identifier that created the file system.
- per
Unit IntegerStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root
Squash LustreConfiguration File System Root Squash Configuration - 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. - security
Group List<String>Ids - 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 BooleanBackup 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.
- storage
Capacity Integer - 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage
Type String - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - subnet
Ids 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:
- 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id String - Identifier of the Virtual Private Cloud for the file system.
- weekly
Maintenance StringStart Time - 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.
- auto
Import stringPolicy - 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. - automatic
Backup numberRetention Days - 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
andPERSISTENT_2
deployment_type. - backup
Id string - The ID of the source backup to create the filesystem from.
- boolean
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily
Automatic stringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data
Compression stringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment
Type string - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - dns
Name string - DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.com
- drive
Cache stringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file
System stringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - {[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.
- import
Path 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_1
deployment types. - imported
File numberChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log
Configuration LustreFile System Log Configuration - 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. - metadata
Configuration LustreFile System Metadata Configuration - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - mount
Name string - The value to be used when mounting the filesystem.
- network
Interface string[]Ids - 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 string - AWS account identifier that created the file system.
- per
Unit numberStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root
Squash LustreConfiguration File System Root Squash Configuration - 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. - security
Group string[]Ids - 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 booleanBackup 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.
- storage
Capacity number - 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage
Type string - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - subnet
Ids 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:
- {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id string - Identifier of the Virtual Private Cloud for the file system.
- weekly
Maintenance stringStart Time - 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_ strpolicy - 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. - automatic_
backup_ intretention_ days - 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
andPERSISTENT_2
deployment_type. - backup_
id str - The ID of the source backup to create the filesystem from.
- bool
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily_
automatic_ strbackup_ start_ time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data_
compression_ strtype - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - 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_ strtype - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file_
system_ strtype_ version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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 - 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_1
deployment types. - imported_
file_ intchunk_ size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms_
key_ strid - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log_
configuration LustreFile System Log Configuration Args - 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. - metadata_
configuration LustreFile System Metadata Configuration Args - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - mount_
name str - The value to be used when mounting the filesystem.
- network_
interface_ Sequence[str]ids - 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_ intstorage_ throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root_
squash_ Lustreconfiguration File System Root Squash Configuration Args - 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. - security_
group_ Sequence[str]ids - 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_ boolbackup 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.
- storage_
capacity 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage_
type str - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_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:
- 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc_
id str - Identifier of the Virtual Private Cloud for the file system.
- weekly_
maintenance_ strstart_ time - 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.
- auto
Import StringPolicy - 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. - automatic
Backup NumberRetention Days - 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
andPERSISTENT_2
deployment_type. - backup
Id String - The ID of the source backup to create the filesystem from.
- Boolean
- A boolean flag indicating whether tags for the file system should be copied to backups. Applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. The default value is false. - daily
Automatic StringBackup Start Time - 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
andPERSISTENT_2
deployment_type. Requiresautomatic_backup_retention_days
to be set. - data
Compression StringType - Sets the data compression configuration for the file system. Valid values are
LZ4
andNONE
. Default value isNONE
. Unsetting this value reverts the compression type back toNONE
. - deployment
Type String - The filesystem deployment type. One of:
SCRATCH_1
,SCRATCH_2
,PERSISTENT_1
,PERSISTENT_2
. - dns
Name String - DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.com
- drive
Cache StringType - The type of drive cache used by
PERSISTENT_1
filesystems that are provisioned withHDD
storage_type. Required forHDD
storage_type, set to eitherREAD
orNONE
. - export
Path 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 inimport_path
. Set equal toimport_path
to overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}
. Only supported onPERSISTENT_1
deployment types. - file
System StringType Version - Sets the Lustre version for the file system that you're creating. Valid values are 2.10 for
SCRATCH_1
,SCRATCH_2
andPERSISTENT_1
deployment types. Valid values for 2.12 include all deployment types. - 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.
- import
Path 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_1
deployment types. - imported
File NumberChunk Size - 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 to1024
. Minimum of1
and maximum of512000
. Only supported onPERSISTENT_1
deployment types. - kms
Key StringId - ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1
andPERSISTENT_2
deployment_type. Defaults to an AWS managed KMS Key. - log
Configuration Property Map - 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. - metadata
Configuration Property Map - 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 toPERSISTENT_2
. Seemetadata_configuration
Block for details. - mount
Name String - The value to be used when mounting the filesystem.
- network
Interface List<String>Ids - 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 String - AWS account identifier that created the file system.
- per
Unit NumberStorage Throughput - Describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1
andPERSISTENT_2
deployment_type. Valid values forPERSISTENT_1
deployment_type andSSD
storage_type are 50, 100, 200. Valid values forPERSISTENT_1
deployment_type andHDD
storage_type are 12, 40. Valid values forPERSISTENT_2
deployment_type andSSD
storage_type are 125, 250, 500, 1000. - root
Squash Property MapConfiguration - 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. - security
Group List<String>Ids - 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 BooleanBackup 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.
- storage
Capacity Number - 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 forSCRATCH_2
,PERSISTENT_1
andPERSISTENT_2
deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup. - storage
Type String - The filesystem storage type. Either
SSD
orHDD
, defaults toSSD
.HDD
is only supported onPERSISTENT_1
deployment types. - subnet
Ids 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:
- 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id String - Identifier of the Virtual Private Cloud for the file system.
- weekly
Maintenance StringStart Time - 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
andDISABLED
. Default value isDISABLED
.
- 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
andDISABLED
. Default value isDISABLED
.
- 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
andDISABLED
. Default value isDISABLED
.
- 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
andDISABLED
. Default value isDISABLED
.
- 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
andDISABLED
. Default value isDISABLED
.
- 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
andDISABLED
. Default value isDISABLED
.
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 are1500
,3000
,6000
and12000
through192000
in increments of12000
. - Mode string
Mode for the metadata configuration of the file system. Valid values are
AUTOMATIC
, andUSER_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
- Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to
USER_PROVISIONED
. Valid Values are1500
,3000
,6000
and12000
through192000
in increments of12000
. - Mode string
Mode for the metadata configuration of the file system. Valid values are
AUTOMATIC
, andUSER_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
- Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to
USER_PROVISIONED
. Valid Values are1500
,3000
,6000
and12000
through192000
in increments of12000
. - mode String
Mode for the metadata configuration of the file system. Valid values are
AUTOMATIC
, andUSER_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
- Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to
USER_PROVISIONED
. Valid Values are1500
,3000
,6000
and12000
through192000
in increments of12000
. - mode string
Mode for the metadata configuration of the file system. Valid values are
AUTOMATIC
, andUSER_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
- Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to
USER_PROVISIONED
. Valid Values are1500
,3000
,6000
and12000
through192000
in increments of12000
. - mode str
Mode for the metadata configuration of the file system. Valid values are
AUTOMATIC
, andUSER_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
- Amount of IOPS provisioned for metadata. This parameter should only be used when the mode is set to
USER_PROVISIONED
. Valid Values are1500
,3000
,6000
and12000
through192000
in increments of12000
. - mode String
Mode for the metadata configuration of the file system. Valid values are
AUTOMATIC
, andUSER_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
- No
Squash List<string>Nids - 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 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 []stringNids - 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 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 List<String>Nids - 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 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 string[]Nids - 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 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_ Sequence[str]nids - 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.
- no
Squash List<String>Nids - 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 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.