LustreFileSystemState class
Input properties used for looking up and filtering LustreFileSystem resources.
Constructors
-
LustreFileSystemState({Input<
String?> ? arn, Input<String?> ? autoImportPolicy, Input<int?> ? automaticBackupRetentionDays, Input<String?> ? backupId, Input<bool?> ? copyTagsToBackups, Input<String?> ? dailyAutomaticBackupStartTime, Input<String?> ? dataCompressionType, Input<LustreFileSystemDataReadCacheConfiguration?> ? dataReadCacheConfiguration, Input<String?> ? deploymentType, Input<String?> ? dnsName, Input<String?> ? driveCacheType, Input<bool?> ? efaEnabled, Input<String?> ? exportPath, Input<String?> ? fileSystemTypeVersion, Input<Map< ? finalBackupTags, Input<String, String> ?>String?> ? importPath, Input<int?> ? importedFileChunkSize, Input<String?> ? kmsKeyId, Input<LustreFileSystemLogConfiguration?> ? logConfiguration, Input<LustreFileSystemMetadataConfiguration?> ? metadataConfiguration, Input<String?> ? mountName, Input<List< ? networkInterfaceIds, Input<String> ?>String?> ? ownerId, Input<int?> ? perUnitStorageThroughput, Input<String?> ? region, Input<LustreFileSystemRootSquashConfiguration?> ? rootSquashConfiguration, Input<List< ? securityGroupIds, Input<String> ?>bool?> ? skipFinalBackup, Input<int?> ? storageCapacity, Input<String?> ? storageType, Input<String?> ? subnetIds, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>int?> ? throughputCapacity, Input<String?> ? vpcId, Input<String?> ? weeklyMaintenanceStartTime}) -
Creates a new LustreFileSystemState.
arnARN of the file system.autoImportPolicyHow 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 onPERSISTENT_1deployment types.automaticBackupRetentionDaysNumber 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 forPERSISTENT_1andPERSISTENT_2deployment_type.backupIdID of the source backup to create the filesystem from.copyTagsToBackupsWhether to copy tags for the file system to backups. Applicable forPERSISTENT_1andPERSISTENT_2deployment_type. The default value is false.dailyAutomaticBackupStartTimeRecurring 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 forPERSISTENT_1andPERSISTENT_2deployment_type. RequiresautomaticBackupRetentionDaysto be set.dataCompressionTypeSets the data compression configuration for the file system. Valid values areLZ4andNONE. Default value isNONE. Unsetting this value reverts the compression type back toNONE.dataReadCacheConfigurationOptional.deploymentTypeFilesystem deployment type. One of:SCRATCH_1,SCRATCH_2,PERSISTENT_1,PERSISTENT_2.dnsNameDNS name for the file system, e.g.,fs-12345678.fsx.us-west-2.amazonaws.comdriveCacheTypeType of drive cache used byPERSISTENT_1filesystems that are provisioned withHDDstorage_type. Required forHDDstorage_type, set to eitherREADorNONE.efaEnabledAdds support for Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) to Lustre. This must be set at creation. If set this cannot be changed and this prevents changes toperUnitStorageThroughput. This is only supported when deploymentType is set toPERSISTENT_2,metadataConfigurationis used, and an EFA-enabled security group is attached.exportPathS3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified withimportPathargument and the path must use the same Amazon S3 bucket as specified inimportPath. Set equal toimportPathto overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}. Only supported onPERSISTENT_1deployment types.fileSystemTypeVersionSets the Lustre version for the file system. Valid values are2.10,2.12, and2.15. When creating a file system,2.10is valid forSCRATCH_1,SCRATCH_2, andPERSISTENT_1deployment types;2.12and2.15are valid for all deployment types. Changing this value to a higher version triggers an in-place upgrade. Changing to a lower version forces resource replacement (destroy and recreate).finalBackupTagsMap of tags to apply to the file system's final backup.importPathS3 URI (with optional prefix) that you're using as the data repository for your FSx for Lustre file system. For example,s3://example-bucket/optional-prefix/. Only supported onPERSISTENT_1deployment types.importedFileChunkSizeFor 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 withimportPathargument. Defaults to1024. Minimum of1and maximum of512000. Only supported onPERSISTENT_1deployment types.kmsKeyIdARN for the KMS Key to encrypt the file system at rest, applicable forPERSISTENT_1andPERSISTENT_2deployment_type. Defaults to an AWS managed KMS Key.logConfigurationLustre 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. SeelogConfigurationBlock for details.metadataConfigurationLustre 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 whendeploymentTypeis set toPERSISTENT_2. SeemetadataConfigurationBlock for details.mountNameValue to be used when mounting the filesystem.networkInterfaceIdsSet 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.ownerIdAWS account identifier that created the file system.perUnitStorageThroughputAmount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for thePERSISTENT_1andPERSISTENT_2deployment_type. Valid values forPERSISTENT_1deploymentType andSSDstorageType are 50, 100, 200. Valid values forPERSISTENT_1deploymentType andHDDstorageType are 12, 40. Valid values forPERSISTENT_2deploymentType andSSDstorageType are 125, 250, 500, 1000.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.rootSquashConfigurationLustre 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. SeerootSquashConfigurationBlock for details.securityGroupIdsList 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.skipFinalBackupWhen 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 totrue.storageCapacityStorage capacity (GiB) of the file system. Minimum of1200. See more details at Allowed values for Fsx storage capacity. Update is allowed only forSCRATCH_2,PERSISTENT_1andPERSISTENT_2deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup.storageTypeFilesystem storage type. One ofSSD,HDDorINTELLIGENT_TIERING, defaults toSSD.HDDis only supported onPERSISTENT_1deployment types.INTELLIGENT_TIERINGrequiresdataReadCacheConfigurationandmetadataConfigurationto be set and is only supported forPERSISTENT_2deployment types.subnetIdsList 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.tagsMap of tags to assign to the file system. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.throughputCapacityThroughput in MBps required for theINTELLIGENT_TIERINGstorage type. Must be 4000 or multiples of 4000.vpcIdIdentifier of the VPC for the file system.weeklyMaintenanceStartTimePreferred start time (ind:HH:MMformat) to perform weekly maintenance, in the UTC time zone.const -
LustreFileSystemState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the file system.
final
-
autoImportPolicy
→ Input<
String?> ? -
How Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. see Auto Import Data Repo for more details. Only supported on
PERSISTENT_1deployment types.final -
automaticBackupRetentionDays
→ Input<
int?> ? -
Number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. only valid for
PERSISTENT_1andPERSISTENT_2deployment_type.final -
backupId
→ Input<
String?> ? -
ID of the source backup to create the filesystem from.
final
-
copyTagsToBackups
→ Input<
bool?> ? -
Whether to copy tags for the file system to backups. Applicable for
PERSISTENT_1andPERSISTENT_2deployment_type. The default value is false.final -
dailyAutomaticBackupStartTime
→ Input<
String?> ? -
Recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. only valid for
PERSISTENT_1andPERSISTENT_2deployment_type. RequiresautomaticBackupRetentionDaysto be set.final -
dataCompressionType
→ Input<
String?> ? -
Sets the data compression configuration for the file system. Valid values are
LZ4andNONE. Default value isNONE. Unsetting this value reverts the compression type back toNONE.final -
dataReadCacheConfiguration
→ Input<
LustreFileSystemDataReadCacheConfiguration?> ? -
final
-
deploymentType
→ Input<
String?> ? -
Filesystem deployment type. One of:
SCRATCH_1,SCRATCH_2,PERSISTENT_1,PERSISTENT_2.final -
dnsName
→ Input<
String?> ? -
DNS name for the file system, e.g.,
fs-12345678.fsx.us-west-2.amazonaws.comfinal -
driveCacheType
→ Input<
String?> ? -
Type of drive cache used by
PERSISTENT_1filesystems that are provisioned withHDDstorage_type. Required forHDDstorage_type, set to eitherREADorNONE.final -
efaEnabled
→ Input<
bool?> ? -
Adds support for Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) to Lustre. This must be set at creation. If set this cannot be changed and this prevents changes to
perUnitStorageThroughput. This is only supported when deploymentType is set toPERSISTENT_2,metadataConfigurationis used, and an EFA-enabled security group is attached.final -
exportPath
→ Input<
String?> ? -
S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with
importPathargument and the path must use the same Amazon S3 bucket as specified inimportPath. Set equal toimportPathto overwrite files on export. Defaults tos3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}. Only supported onPERSISTENT_1deployment types.final -
fileSystemTypeVersion
→ Input<
String?> ? -
Sets the Lustre version for the file system. Valid values are
2.10,2.12, and2.15. When creating a file system,2.10is valid forSCRATCH_1,SCRATCH_2, andPERSISTENT_1deployment types;2.12and2.15are valid for all deployment types. Changing this value to a higher version triggers an in-place upgrade. Changing to a lower version forces resource replacement (destroy and recreate).final -
finalBackupTags
→ Input<
Map< ?String, String> ?> -
Map of tags to apply to the file system's final backup.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
importedFileChunkSize
→ Input<
int?> ? -
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. Can only be specified with
importPathargument. Defaults to1024. Minimum of1and maximum of512000. Only supported onPERSISTENT_1deployment types.final -
importPath
→ Input<
String?> ? -
S3 URI (with optional prefix) that you're using as the data repository for your FSx for Lustre file system. For example,
s3://example-bucket/optional-prefix/. Only supported onPERSISTENT_1deployment types.final -
kmsKeyId
→ Input<
String?> ? -
ARN for the KMS Key to encrypt the file system at rest, applicable for
PERSISTENT_1andPERSISTENT_2deployment_type. Defaults to an AWS managed KMS Key.final -
logConfiguration
→ Input<
LustreFileSystemLogConfiguration?> ? -
Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs. See
logConfigurationBlock for details.final -
metadataConfiguration
→ Input<
LustreFileSystemMetadataConfiguration?> ? -
Lustre metadata configuration used when creating an Amazon FSx for Lustre file system. This can be used to specify a user provisioned metadata scale. This is only supported when
deploymentTypeis set toPERSISTENT_2. SeemetadataConfigurationBlock for details.final -
mountName
→ Input<
String?> ? -
Value to be used when mounting the filesystem.
final
-
networkInterfaceIds
→ Input<
List< ?String> ?> -
Set of Elastic Network Interface identifiers from which the file system is accessible. As explained in the documentation, the first network interface returned is the primary network interface.
final
-
ownerId
→ Input<
String?> ? -
AWS account identifier that created the file system.
final
-
perUnitStorageThroughput
→ Input<
int?> ? -
Amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB, required for the
PERSISTENT_1andPERSISTENT_2deployment_type. Valid values forPERSISTENT_1deploymentType andSSDstorageType are 50, 100, 200. Valid values forPERSISTENT_1deploymentType andHDDstorageType are 12, 40. Valid values forPERSISTENT_2deploymentType andSSDstorageType are 125, 250, 500, 1000.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
rootSquashConfiguration
→ Input<
LustreFileSystemRootSquashConfiguration?> ? -
Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. See
rootSquashConfigurationBlock for details.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroupIds
→ Input<
List< ?String> ?> -
List of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
final
-
skipFinalBackup
→ Input<
bool?> ? -
When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to
true.final -
storageCapacity
→ Input<
int?> ? -
Storage capacity (GiB) of the file system. Minimum of
1200. See more details at Allowed values for Fsx storage capacity. Update is allowed only forSCRATCH_2,PERSISTENT_1andPERSISTENT_2deployment types, See more details at Fsx Storage Capacity Update. Required when not creating filesystem for a backup.final -
storageType
→ Input<
String?> ? -
Filesystem storage type. One of
SSD,HDDorINTELLIGENT_TIERING, defaults toSSD.HDDis only supported onPERSISTENT_1deployment types.INTELLIGENT_TIERINGrequiresdataReadCacheConfigurationandmetadataConfigurationto be set and is only supported forPERSISTENT_2deployment types.final -
subnetIds
→ Input<
String?> ? -
List of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone.
final
-
Map of tags to assign to the file system. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
throughputCapacity
→ Input<
int?> ? -
Throughput in MBps required for the
INTELLIGENT_TIERINGstorage type. Must be 4000 or multiples of 4000.final -
vpcId
→ Input<
String?> ? -
Identifier of the VPC for the file system.
final
-
weeklyMaintenanceStartTime
→ Input<
String?> ? -
Preferred start time (in
d:HH:MMformat) to perform weekly maintenance, in the UTC time zone.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited