String administrativeActionType
Integer progressPercent
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.
Date requestTime
Time that the administrative action request was received.
String status
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system
with the new storage capacity, and is now performing the storage optimization process. For more information, see
Managing Storage
Capacity.
FileSystem targetFileSystemValues
Describes the target StorageCapacity or ThroughputCapacity value provided in the
UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
AdministrativeActionFailureDetails failureDetails
String message
Error message providing details about the failure.
String backupId
The ID of the backup.
String lifecycle
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
CREATING - FSx is creating the backup.
TRANSFERRING - For Lustre file systems only; FSx is transferring the backup to S3.
DELETED - The backup was deleted is no longer available.
FAILED - Amazon FSx could not complete the backup.
BackupFailureDetails failureDetails
Details explaining any failures that occur when creating a backup.
String type
The type of the file system backup.
Integer progressPercent
Date creationTime
The time when a particular backup was created.
String kmsKeyId
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
String resourceARN
The Amazon Resource Name (ARN) for the backup resource.
List<E> tags
Tags associated with a particular file system.
FileSystem fileSystem
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
ActiveDirectoryBackupAttributes directoryInformation
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
String message
A message describing the backup creation failure.
String fileSystemId
The ID of a file system being restored from the backup.
String taskId
Specifies the data repository task to cancel.
String lifecycle
The lifecycle status of the data repository task, as follows:
PENDING - Amazon FSx has not started the task.
EXECUTING - Amazon FSx is processing the task.
FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task
failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
failures.
SUCCEEDED - FSx completed the task successfully.
CANCELED - Amazon FSx canceled the task and it did not complete.
CANCELING - FSx is in process of canceling the task.
String taskId
The ID of the task being canceled.
Boolean enabled
Set Enabled to True to generate a CompletionReport when the task
completes. If set to true, then you need to provide a report Scope, Path,
and Format. Set Enabled to False if you do not want a
CompletionReport generated when the task completes.
String path
Required if Enabled is set to true. Specifies the location of the report on the file
system's linked S3 data repository. An absolute path that defines where the completion report will be stored in
the destination location. The Path you provide must be located within the file system’s ExportPath.
An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the
following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a
file system's ExportPath, see .
String format
Required if Enabled is set to true. Specifies the format of the
CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When
Format is set to REPORT_CSV_20191124, the CompletionReport is provided in
CSV format, and is delivered to {path}/task-{id}/failures.csv.
String scope
Required if Enabled is set to true. Specifies the scope of the
CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When
Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains
information about files that the data repository task failed to process.
String fileSystemId
The ID of the file system to back up.
String clientRequestToken
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
List<E> tags
(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears
in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or
more tags using the CreateBackup action, no existing file system tags are copied from the file
system to the backup.
Backup backup
A description of the backup.
String type
Specifies the type of data repository task to create.
List<E> paths
(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The
default path is the file system root directory. The paths you provide need to be relative to the mount point of
the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or
file on the file system you want to export, then the path to provide is path1. If a path that you
provide isn't valid, the task fails.
String fileSystemId
CompletionReport report
Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport
provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the
Scope parameter. For more information, see Working with Task
Completion Reports.
String clientRequestToken
List<E> tags
DataRepositoryTask dataRepositoryTask
The description of the data repository task that you just created.
String backupId
String clientRequestToken
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
List<E> subnetIds
Specifies the IDs of the subnets that the file system will be accessible from. For Windows
MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file
server and one for the standby file server. You specify one of these subnets as the preferred subnet using the
WindowsConfiguration > PreferredSubnetID property.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment types and Lustre file systems,
provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
List<E> securityGroupIds
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
List<E> tags
The tags to be applied to the file system at file system creation. The key value of the Name tag
appears in the console as the file system name.
CreateFileSystemWindowsConfiguration windowsConfiguration
The configuration for this Microsoft Windows file system.
CreateFileSystemLustreConfiguration lustreConfiguration
String storageType
Sets the storage type for the Windows file system you're creating from a backup. Valid values are
SSD and HDD.
Set to SSD to use solid state drive storage. Supported on all Windows deployment types.
Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2 and
MULTI_AZ_1 Windows file system deployment types.
Default value is SSD.
HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB.
FileSystem fileSystem
A description of the file system.
String weeklyMaintenanceStartTime
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
String importPath
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data
repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped
to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If
you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file
system.
String exportPath
(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the
same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed
data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not
provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp].
The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you
only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects
to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a
custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx
exports the contents of your file system to that export prefix in the Amazon S3 bucket.
Integer importedFileChunkSize
(Optional) 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. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
String deploymentType
Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and
shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of
data and higher burst throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 deployment type for longer-term storage and workloads and encryption of data in
transit. To learn more about deployment types, see FSx for Lustre Deployment
Options.
Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or
PERSISTENT_1 file system from Amazon EC2 instances that support this feature.
(Default = SCRATCH_1)
Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is
supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in
Transit.
String autoImportPolicy
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use
this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify
objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the
linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or
changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added
to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any
new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose
this option.
For more information, see Automatically import updates from your S3 bucket.
Integer perUnitStorageThroughput
Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for
each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system
storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50
MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of
throughput that you provision.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
String dailyAutomaticBackupStartTime
Integer automaticBackupRetentionDays
Boolean copyTagsToBackups
(Optional) Not available to use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If it's set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
For more information, see Working with backups.
String driveCacheType
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This
parameter is required when storage type is HDD. Set to READ, improve the performance for frequently
accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
String clientRequestToken
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
String fileSystemType
The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
Integer storageCapacity
Sets the storage capacity of the file system that you're creating.
For Lustre file systems:
For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400
GiB, and increments of 2400 GiB.
For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file
systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
For Windows file systems:
If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
String storageType
Sets the storage type for the file system you're creating. Valid values are SSD and HDD
.
Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment
types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and
MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system
deployment types.
Default value is SSD. For more information, see Storage
Type Options in the Amazon FSx for Windows User Guide and Multiple Storage
Options in the Amazon FSx for Lustre User Guide.
List<E> subnetIds
Specifies the IDs of the subnets that the file system will be accessible from. For Windows
MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file
server and one for the standby file server. You specify one of these subnets as the preferred subnet using the
WindowsConfiguration > PreferredSubnetID property.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file
systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
List<E> securityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
List<E> tags
The tags to apply to the file system being created. The key value of the Name tag appears in the
console as the file system name.
String kmsKeyId
CreateFileSystemWindowsConfiguration windowsConfiguration
The Microsoft Windows configuration for the file system being created.
CreateFileSystemLustreConfiguration lustreConfiguration
FileSystem fileSystem
The configuration of the file system that was created.
String activeDirectoryId
The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
SelfManagedActiveDirectoryConfiguration selfManagedActiveDirectoryConfiguration
String deploymentType
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to
tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS
Regions that have a minimum of three Availability Zones. Also supports HDD storage type
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is
configured for single AZ redundancy and supports HDD storage type.
For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
String preferredSubnetId
Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which
you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your
clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs
and minimize latency.
Integer throughputCapacity
The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
String weeklyMaintenanceStartTime
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
String dailyAutomaticBackupStartTime
The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
Integer automaticBackupRetentionDays
The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.
Boolean copyTagsToBackups
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
String lifecycle
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data
repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data
repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.
UPDATING - The data repository is undergoing a customer initiated update and availability may be
impacted.
String importPath
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your
FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified
after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
String exportPath
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
Integer importedFileChunkSize
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. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
String autoImportPolicy
Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy
configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your
linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the
linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or
changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added
to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any
new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose
this option.
For more information, see Automatically import updates from your S3 bucket.
DataRepositoryFailureDetails failureDetails
String message
String taskId
The system-generated, unique 17-digit ID of the data repository task.
String lifecycle
The lifecycle status of the data repository task, as follows:
PENDING - Amazon FSx has not started the task.
EXECUTING - Amazon FSx is processing the task.
FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task
failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
failures.
SUCCEEDED - FSx completed the task successfully.
CANCELED - Amazon FSx canceled the task and it did not complete.
CANCELING - FSx is in process of canceling the task.
You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
PENDING or EXECUTING states. Please retry when the data repository task is finished
(with a status of CANCELED, SUCCEEDED, or FAILED). You can use the
DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
file system immediately.
String type
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
Date creationTime
Date startTime
The time that Amazon FSx began processing the task.
Date endTime
The time that Amazon FSx completed processing the task, populated after the task is complete.
String resourceARN
List<E> tags
String fileSystemId
List<E> paths
An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
(Default) If Paths is not specified, Amazon FSx uses the file system root directory.
DataRepositoryTaskFailureDetails failureDetails
Failure message describing why the task failed, it is populated only when Lifecycle is set to
FAILED.
DataRepositoryTaskStatus status
Provides the status of the number of files that the task has processed successfully and failed to process.
CompletionReport report
String message
String name
Name of the task property to use in filtering the tasks returned in the response.
Use file-system-id to retrieve data repository tasks for specific file systems.
Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as
follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.
List<E> values
Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.
Long totalCount
The total number of files that the task will process. While a task is executing, the sum of
SucceededCount plus FailedCount may not equal TotalCount. When the task is
complete, TotalCount equals the sum of SucceededCount plus FailedCount.
Long succeededCount
A running total of the number of files that the task has successfully processed.
Long failedCount
A running total of the number of files that the task failed to process.
Date lastUpdatedTime
The time at which the task status was last updated.
Boolean skipFinalBackup
Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting.
By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem
operation is invoked. (Default = true)
List<E> finalBackupTags
Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the
final backup. If you have set the file system property CopyTagsToBackups to true, and you specify
one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file
system tags to the backup.
String fileSystemId
The ID of the file system you want to delete.
String clientRequestToken
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.
DeleteFileSystemWindowsConfiguration windowsConfiguration
DeleteFileSystemLustreConfiguration lustreConfiguration
String fileSystemId
The ID of the file system being deleted.
String lifecycle
The file system lifecycle for the deletion request. Should be DELETING.
DeleteFileSystemWindowsResponse windowsResponse
DeleteFileSystemLustreResponse lustreResponse
Boolean skipFinalBackup
By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem
operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final
backup. If you want to skip this backup, use this flag to do so.
List<E> finalBackupTags
A set of tags for your final backup.
List<E> backupIds
IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.
List<E> filters
Filters structure. Supported names are file-system-id and backup-type.
Integer maxResults
Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The
number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the
request and the service's internal maximum number of items per page.
String nextToken
Opaque pagination token returned from a previous DescribeBackups operation (String). If a token
present, the action continues the list from where the returning call left off.
List<E> taskIds
(Optional) IDs of the tasks whose descriptions you want to retrieve (String).
List<E> filters
(Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just
tasks for specific file systems, or tasks in a specific lifecycle state.
Integer maxResults
String nextToken
List<E> fileSystemIds
IDs of the file systems whose descriptions you want to retrieve (String).
Integer maxResults
Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0.
The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in
the request and the service's internal maximum number of items per page.
String nextToken
Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token
present, the action continues the list from where the returning call left off.
String ownerId
The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.
Date creationTime
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
String fileSystemId
The system-generated, unique 17-digit ID of the file system.
String fileSystemType
The type of Amazon FSx file system, either LUSTRE or WINDOWS.
String lifecycle
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file
system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FileSystemFailureDetails failureDetails
Integer storageCapacity
The storage capacity of the file system in gigabytes (GB).
String storageType
The storage type of the file system. Valid values are SSD and HDD. If set to
SSD, the file system uses solid state drive storage. If set to HDD, the file system
uses hard disk drive storage.
String vpcId
The ID of the primary VPC for the file system.
List<E> subnetIds
Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1
file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby
file server. The preferred file server subnet identified in the PreferredSubnetID property. All
other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the
endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system
is available in the PreferredSubnetID.
List<E> networkInterfaceIds
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
String dNSName
The DNS name for the file system.
String kmsKeyId
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.
String resourceARN
The Amazon Resource Name (ARN) for the file system resource.
List<E> tags
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
WindowsFileSystemConfiguration windowsConfiguration
The configuration for this Microsoft Windows file system.
LustreFileSystemConfiguration lustreConfiguration
List<E> administrativeActions
A list of administrative actions for the file system that are in process or waiting to be processed.
Administrative actions describe changes to the Windows file system that you have initiated using the
UpdateFileSystem action.
String message
A message describing any failures that occurred during file system creation.
String parameter
A parameter that is incompatible with the earlier request.
String resourceARN
The ARN of the Amazon FSx resource that will have its tags listed.
Integer maxResults
Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The
number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the
request and the service's internal maximum number of items per page.
String nextToken
Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token
present, the action continues the list from where the returning call left off.
String weeklyMaintenanceStartTime
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration dataRepositoryConfiguration
String deploymentType
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary
storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit
encryption of data and higher burst throughput capacity than SCRATCH_1.
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of
data in transit. To learn more about deployment types, see FSx for Lustre Deployment
Options. (Default = SCRATCH_1)
Integer perUnitStorageThroughput
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of
storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) *
PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
String mountName
You use the MountName value when mounting the file system.
For the SCRATCH_1 deployment type, this value is always "fsx". For
SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique
within an AWS Region.
String dailyAutomaticBackupStartTime
Integer automaticBackupRetentionDays
Boolean copyTagsToBackups
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
String driveCacheType
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This
parameter is required when storage type is HDD. Set to READ, improve the performance for frequently
accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
String resourceARN
The Amazon Resource Name (ARN) of the non-Amazon FSx resource.
String resourceARN
The Amazon Resource Name (ARN) of the resource that doesn't support tagging.
String resourceARN
The resource ARN of the resource that can't be found.
String domainName
The fully qualified domain name of the self-managed AD directory.
String organizationalUnitDistinguishedName
The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.
String fileSystemAdministratorsGroup
The name of the domain group whose members have administrative privileges for the FSx file system.
String userName
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
List<E> dnsIps
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
String domainName
The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
String organizationalUnitDistinguishedName
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD
directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the
file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in
the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
String fileSystemAdministratorsGroup
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
String userName
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
domain. This account must have the permission to join computers to the domain in the organizational unit provided
in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
String password
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
List<E> dnsIps
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
10.0.0.0 - 10.255.255.255 (10/8 prefix)
172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
String userName
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
domain. This account must have the permission to join computers to the domain in the organizational unit provided
in OrganizationalUnitDistinguishedName.
String password
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
List<E> dnsIps
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
String limit
Enumeration of the service limit that was exceeded.
String key
A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to
which they are attached.
String value
A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can
be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of
finances : April and also of payroll : April.
String weeklyMaintenanceStartTime
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
String dailyAutomaticBackupStartTime
Integer automaticBackupRetentionDays
String autoImportPolicy
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use
this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify
objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the
linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new
or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added
to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any
new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose
this option.
For more information, see Automatically import updates from your S3 bucket.
String fileSystemId
Identifies the file system that you are updating.
String clientRequestToken
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
Integer storageCapacity
Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server file system. Specifies the storage capacity target value, GiB, for the file system you're updating. The storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system needs to have at least 16 MB/s of throughput capacity. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress. For more information, see Managing Storage Capacity.
UpdateFileSystemWindowsConfiguration windowsConfiguration
The configuration updates for an Amazon FSx for Windows File Server file system.
UpdateFileSystemLustreConfiguration lustreConfiguration
FileSystem fileSystem
A description of the file system that was updated.
String weeklyMaintenanceStartTime
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.
String dailyAutomaticBackupStartTime
The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00
Integer automaticBackupRetentionDays
The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups.
Integer throughputCapacity
Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.
SelfManagedActiveDirectoryConfigurationUpdates selfManagedActiveDirectoryConfiguration
The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.
String activeDirectoryId
The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.
SelfManagedActiveDirectoryAttributes selfManagedActiveDirectoryConfiguration
String deploymentType
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to
tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only
supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured
for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems.
String remoteAdministrationEndpoint
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file
system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file
system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
String preferredSubnetId
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server
is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves
traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for
SubnetIDs. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems
String preferredFileServerIp
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.
Integer throughputCapacity
The throughput of an Amazon FSx file system, measured in megabytes per second.
List<E> maintenanceOperationsInProgress
The list of maintenance operations in progress for this file system.
String weeklyMaintenanceStartTime
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
String dailyAutomaticBackupStartTime
The preferred time to take daily automatic backups, in the UTC time zone.
Integer automaticBackupRetentionDays
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.
Boolean copyTagsToBackups
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Copyright © 2020. All rights reserved.