String administrativeActionType
Integer progressPercent
The percentage-complete status of a STORAGE_OPTIMIZATION administrative action. Does not apply to
any other administrative action type.
Date requestTime
The 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.
FileSystem targetFileSystemValues
Describes the target value for the administration action, provided in the UpdateFileSystem
operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
AdministrativeActionFailureDetails failureDetails
Volume targetVolumeValues
Snapshot targetSnapshotValues
String message
Error message providing details about the failed administrative action.
String name
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example,
accounting.example.com.
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
String lifecycle
Describes the state of the DNS alias.
AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.
String clientRequestToken
String fileSystemId
Specifies the file system with which you want to associate one or more DNS aliases.
List<E> aliases
An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example,
accounting.corp.example.com.
Can contain alphanumeric characters and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
String type
Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this
value to NONE disables autocommit. The default value is NONE.
Integer value
Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:
Minutes: 5 - 65,535
Hours: 1 - 65,535
Days: 1 - 3,650
Months: 1 - 120
Years: 1 - 10
List<E> events
The AutoExportPolicy can have the following event values:
NEW - New files and directories are automatically exported to the data repository as they are added
to the file system.
CHANGED - Changes to files and directories on the file system are automatically exported to the data
repository.
DELETED - Files and directories are automatically deleted on the data repository when they are
deleted on the file system.
You can define any combination of event types for your AutoExportPolicy.
List<E> events
The AutoImportPolicy can have the following event values:
NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not
currently exist in the FSx file system.
CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on
the file system as files change in the data repository.
DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
deleted in the data repository.
You can define any combination of event types for your AutoImportPolicy.
String backupId
The ID of the backup.
String lifecycle
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating
the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring
the backup to Amazon S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it's no longer available.
FAILED - Amazon FSx couldn't finish the backup.
BackupFailureDetails failureDetails
Details explaining any failures that occurred 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 Key Management Service (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
The tags associated with a particular file system.
FileSystem fileSystem
The 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 directory to which the Windows File Server instance is joined.
String ownerId
String sourceBackupId
String sourceBackupRegion
The source Region of the backup. Specifies the Region from where this backup is copied.
String resourceType
Specifies the resource type that's backed up.
Volume volume
String backupId
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.
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 clientRequestToken
String sourceBackupId
The ID of the source backup. Specifies the ID of the backup that's being copied.
String sourceRegion
The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the
backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If
you don't specify a Region, SourceRegion defaults to the Region where the request is sent from
(in-Region copy).
String kmsKeyId
Boolean copyTags
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value
defaults to false.
If you set CopyTags to true and the source backup has existing tags, you can use the
Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags
doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same
key but different values), the tags created with the Tags parameter take precedence.
List<E> tags
Backup backup
String fileSystemId
The ID of the file system to back up.
String clientRequestToken
(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services 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 operation, no existing file system tags are copied
from the file system to the backup.
String volumeId
(Optional) The ID of the FSx for ONTAP volume to back up.
Backup backup
A description of the backup.
String fileSystemId
String fileSystemPath
A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory
(such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading
forward slash in the name is required. Two data repository associations cannot have overlapping file system
paths. For example, if a data repository is associated with file system path /ns1/, then you cannot
link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data
repository to the file system. You can only specify "/" as the file system path for the first data repository
associated with a file system.
String dataRepositoryPath
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or
prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository
files will be imported from or exported to.
Boolean batchImportMetaDataOnCreate
Set to true to run an import data repository task to import metadata from the data repository to the
file system after the data repository association is created. Default is false.
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.
S3DataRepositoryConfiguration s3
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
String clientRequestToken
List<E> tags
DataRepositoryAssociation association
The response object returned after the data repository association is created.
String type
Specifies the type of data repository task to create.
EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data
repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon
FSx for Lustre file system.
RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have
been exported to a linked S3 bucket and that meet your specified release criteria.
AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.
List<E> paths
A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).
For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to
the Amazon S3 bucket. 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.
For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported
to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix (where myPrefix is optional).
For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.
A file must also meet the last accessed time criteria specified in for the file to be released.
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
Long capacityToRelease
Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that
automatically releases files from the cache.
ReleaseConfiguration releaseConfiguration
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
DataRepositoryTask dataRepositoryTask
The description of the data repository task that you just created.
Integer perUnitStorageThroughput
Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in
MB/s/TiB. The only supported value is 1000.
String deploymentType
Specifies the cache deployment type, which must be CACHE_1.
String weeklyMaintenanceStartTime
FileCacheLustreMetadataConfiguration metadataConfiguration
The configuration for a Lustre MDT (Metadata Target) storage volume.
String clientRequestToken
An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a CreateFileCache operation without the risk of
creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear
whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If
you use the same client request token and the initial call created a cache, the client receives success as long
as the parameters are the same.
String fileCacheType
The type of cache that you're creating, which must be LUSTRE.
String fileCacheTypeVersion
Sets the Lustre version for the cache that you're creating, which must be 2.12.
Integer storageCapacity
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
List<E> subnetIds
List<E> securityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
List<E> tags
Boolean copyTagsToDataRepositoryAssociations
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
String kmsKeyId
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more
information, see Encrypt in
the Key Management Service API Reference.
CreateFileCacheLustreConfiguration lustreConfiguration
The configuration for the Amazon File Cache resource being created.
List<E> dataRepositoryAssociations
A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
FileCacheCreating fileCache
A description of the cache that was created.
String backupId
String clientRequestToken
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services 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.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems,
and OpenZFS 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 or OpenZFS file system that you're creating from a backup. Valid values are
SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment
types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and
MULTI_AZ_1 FSx for Windows File Server file system deployment types.
The 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 if the original SSD file system had a storage capacity of at least 2000 GiB.
String kmsKeyId
String fileSystemTypeVersion
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are
2.10, 2.12, and 2.15.
You don't need to specify FileSystemTypeVersion because it will be applied using the backup's
FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when
creating from backup, the value must match the backup's FileSystemTypeVersion setting.
CreateFileSystemOpenZFSConfiguration openZFSConfiguration
The OpenZFS configuration for the file system that's being created.
Integer storageCapacity
Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB).
Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or
greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter,
the default is the backup's StorageCapacity value.
If used to create a file system other than OpenZFS, you must provide a value that matches the backup's
StorageCapacity value. If you provide any other value, Amazon FSx responds with a 400 Bad Request.
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.
This parameter is not supported for file systems with a data repository association.
String exportPath
(Optional) Specifies the path in the Amazon S3 bucket 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
specify only 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.
This parameter is not supported for file systems with a data repository association.
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.
This parameter is not supported for file systems with a data repository association.
String deploymentType
(Optional) 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 for longer-term storage and for throughput-focused workloads that aren’t
latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all
Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the
highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher
PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 is available in a limited
number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services
Regions in which PERSISTENT_2 is available, see File
system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the
CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access SCRATCH_2,
PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 instances that support
automatic encryption in the Amazon Web Services Regions where they are available. For more information about
encryption in transit for FSx for Lustre file systems, see Encrypting data in
transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1)
String autoImportPolicy
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use
this parameter 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.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings
of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any
objects that were deleted in the S3 bucket.
For more information, see Automatically import updates from your S3 bucket.
This parameter is not supported for file systems with a data repository association.
Integer perUnitStorageThroughput
Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of
read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, 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 PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.
String dailyAutomaticBackupStartTime
Integer automaticBackupRetentionDays
The number of days to retain automatic backups. Setting this property to 0 disables automatic
backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
Boolean copyTagsToBackups
(Optional) Not available for 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
CopyTagsToBackups is 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 CopyTagsToBackups
is set to 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.
(Default = false)
For more information, see Working with backups in the Amazon FSx for Lustre User Guide.
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 this property to READ to improve
the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file
system.
This parameter is required when StorageType is set to HDD.
String dataCompressionType
Sets the data compression configuration for the file system. DataCompressionType can have the
following values:
NONE - (Default) Data compression is turned off when the file system is created.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.
LustreLogCreateConfiguration logConfiguration
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.
LustreRootSquashConfiguration rootSquashConfiguration
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.
Integer automaticBackupRetentionDays
String dailyAutomaticBackupStartTime
String deploymentType
Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to
tolerate temporary Availability Zone (AZ) unavailability.
SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.
String endpointIpAddressRange
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
String fsxAdminPassword
The ONTAP administrative password for the fsxadmin user with which you administer your file system
using the NetApp ONTAP CLI and REST API.
DiskIopsConfiguration diskIopsConfiguration
The SSD IOPS configuration for the FSx for ONTAP file system.
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.
List<E> routeTableIds
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
Integer throughputCapacity
Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
String weeklyMaintenanceStartTime
Integer automaticBackupRetentionDays
Boolean copyTagsToBackups
A Boolean value 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.
Boolean copyTagsToVolumes
A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to
false. If it's set to true, all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are
copied from the file system, regardless of this value.
String dailyAutomaticBackupStartTime
String deploymentType
Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:
MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy
to tolerate temporary unavailability in Availability Zones (AZs). Multi_AZ_1 is available only in
the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and
Europe (Ireland) Amazon Web Services Regions.
SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s.
Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is
available.
SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe
L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West
(Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.
For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
Integer throughputCapacity
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:
For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120,
7680, or 10240 MBps.
For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
You pay for additional throughput capacity that you provision.
String weeklyMaintenanceStartTime
DiskIopsConfiguration diskIopsConfiguration
OpenZFSCreateRootVolumeConfiguration rootVolumeConfiguration
The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.
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.
String endpointIpAddressRange
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
List<E> routeTableIds
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
String clientRequestToken
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
String fileSystemType
The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE,
ONTAP, and OPENZFS.
Integer storageCapacity
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value
that you set for StorageType and the Lustre DeploymentType, as follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD
storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 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.
FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends
on the value that you set for StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
String storageType
Sets the storage type for the file system that you're creating. Valid values are SSD and
HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and
OpenZFS 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_1 Lustre file system
deployment types.
Default value is SSD. For more information, see Storage
type options in the FSx for Windows File Server User Guide and Multiple storage
options in the FSx for Lustre User Guide.
List<E> subnetIds
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP
MULTI_AZ_1 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 or
OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file
system configuration, see Availability and
durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and
durability in the Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, 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 that's 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 that's being created.
CreateFileSystemLustreConfiguration lustreConfiguration
CreateFileSystemOntapConfiguration ontapConfiguration
String fileSystemTypeVersion
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
Valid values are 2.10, 2.12m and 2.15:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
2.12 and 2.15 are supported by all Lustre deployment types. 2.12 or 2.15 is required
when setting FSx for Lustre DeploymentType to PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to PERSISTENT_2,
then the default is 2.12.
If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre
deployment type, the CreateFileSystem operation fails.
CreateFileSystemOpenZFSConfiguration openZFSConfiguration
The OpenZFS configuration for the file system that's being created.
FileSystem fileSystem
The configuration of the file system that was created.
String activeDirectoryId
The ID for an existing Amazon Web Services 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 Amazon
Web Services 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-Amazon Web Services 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
Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), 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. Setting this property to 0 disables automatic
backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
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.
List<E> aliases
An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.
For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
An alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example,
accounting.example.com.
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
WindowsAuditLogCreateConfiguration auditLogConfiguration
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
DiskIopsConfiguration diskIopsConfiguration
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
String junctionPath
Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The
JunctionPath must have a leading forward slash, such as /vol3.
String securityStyle
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients,
and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB
clients, and an application accessing the data uses a Windows user as the service account.
MIXED if the file system is managed by both UNIX and Windows administrators and users consist of
both NFS and SMB clients.
Integer sizeInMegabytes
Specifies the size of the volume, in megabytes (MB), that you are creating.
Boolean storageEfficiencyEnabled
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. This parameter is required.
String storageVirtualMachineId
Specifies the ONTAP SVM in which to create the volume.
TieringPolicy tieringPolicy
String ontapVolumeType
Specifies the type of volume you are creating. Valid values are the following:
RW specifies a read/write volume. RW is the default.
DP specifies a data-protection volume. A DP volume is read-only and can be used as the
destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
String snapshotPolicy
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the
hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of
two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only
retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent
automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
Boolean copyTagsToBackups
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.
CreateSnaplockConfiguration snaplockConfiguration
Specifies the SnapLock configuration for an FSx for ONTAP volume.
String snapshotARN
String copyStrategy
The strategy used when copying data from the snapshot to the new volume.
CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than
copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot
can't be deleted if there is a volume using its copied data.
FULL_COPY - Copies all data from the snapshot to the new volume.
String parentVolumeId
The ID of the volume to use as the parent volume of the volume that you are creating.
Integer storageCapacityReservationGiB
Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting
StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent
volume will always be available for the volume. You can't reserve more storage than the parent volume has. To
not specify a storage capacity reservation, set this to 0 or -1. For more
information, see Volume
properties in the Amazon FSx for OpenZFS User Guide.
Integer storageCapacityQuotaGiB
Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the
storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the
configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota
space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity
quota, set this to -1.
For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.
Integer recordSizeKiB
Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.
String dataCompressionType
Specifies the method used to compress the data on the volume. The compression type is NONE by
default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD
compression provides a higher level of data compression and higher read throughput performance than LZ4
compression.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression
provides a lower level of compression and higher write throughput performance than ZSTD compression.
For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
Boolean copyTagsToSnapshots
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
CreateOpenZFSOriginSnapshotConfiguration originSnapshot
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
Boolean readOnly
A Boolean value indicating whether the volume is read-only.
List<E> nfsExports
The configuration object for mounting a Network File System (NFS) file system.
List<E> userAndGroupQuotas
An object specifying how much storage users or groups can use on the volume.
Boolean auditLogVolume
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is
false. If you set AuditLogVolume to true, the SnapLock volume is created
as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
AutocommitPeriod autocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
String privilegedDelete
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention
periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a
SnapLock volume, you can't re-enable it. The default value is DISABLED.
For more information, see Privileged delete.
SnaplockRetentionPeriod retentionPeriod
Specifies the retention period of an FSx for ONTAP SnapLock volume.
String snaplockType
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:
COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be
deleted until their retention periods expire. This retention mode is used to address government or
industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.
ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users
before their retention periods expire using privileged delete. This retention mode is used to advance an
organization's data integrity and internal compliance or to test retention settings before using SnapLock
Compliance. For more information, see SnapLock Enterprise.
Boolean volumeAppendModeEnabled
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to
create WORM-appendable files and write data to them incrementally. The default value is false.
For more information, see Volume-append mode.
Snapshot snapshot
A description of the snapshot.
CreateSvmActiveDirectoryConfiguration activeDirectoryConfiguration
Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.
String clientRequestToken
String fileSystemId
String name
The name of the SVM.
String svmAdminPassword
The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a
password, you can still use the file system's fsxadmin user to manage the SVM.
List<E> tags
String rootVolumeSecurityStyle
The security style of the root volume of the SVM. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients,
and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB
clients, and an application accessing the data uses a Windows user as the service account.
MIXED if the file system is managed by both UNIX and Windows administrators and users consist of
both NFS and SMB clients.
StorageVirtualMachine storageVirtualMachine
Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
String netBiosName
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
SelfManagedActiveDirectoryConfiguration selfManagedActiveDirectoryConfiguration
Volume volume
Returned after a successful CreateVolumeFromBackup API operation, describing the volume just
created.
String clientRequestToken
String volumeType
Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume
types.
String name
Specifies the name of the volume that you're creating.
CreateOntapVolumeConfiguration ontapConfiguration
Specifies the configuration to use when creating the ONTAP volume.
List<E> tags
CreateOpenZFSVolumeConfiguration openZFSConfiguration
Specifies the configuration to use when creating the OpenZFS volume.
Volume volume
Returned after a successful CreateVolume API operation, describing the volume just created.
String associationId
The system-generated, unique ID of the data repository association.
String resourceARN
String fileSystemId
String lifecycle
Describes the state of a data repository association. The lifecycle can have the following values:
CREATING - The data repository association between the file system or cache and the data repository
is being created. The data repository is unavailable.
AVAILABLE - The data repository association is available for use.
MISCONFIGURED - The data repository association is misconfigured. Until the configuration is
corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).
UPDATING - The data repository association is undergoing a customer initiated update that might
affect its availability.
DELETING - The data repository association is undergoing a customer initiated deletion.
FAILED - The data repository association is in a terminal state that cannot be recovered.
DataRepositoryFailureDetails failureDetails
String fileSystemPath
A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/
) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with
DataRepositoryPath. The leading forward slash in the name is required. Two data repository
associations cannot have overlapping file system paths. For example, if a data repository is associated with file
system path /ns1/, then you cannot link another data repository with file system path
/ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data
repository to the file system. You can only specify "/" as the file system path for the first data repository
associated with a file system.
String dataRepositoryPath
The path to the data repository that will be linked to the cache or file system.
For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export
directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can
therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS
file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories
specified with the DataRepositorySubdirectories parameter.
For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix/.
Boolean batchImportMetaDataOnCreate
A boolean flag indicating whether an import data repository task to import metadata should run after the data
repository association is created. The task runs if this flag is set to true.
BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache
resource.
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 or cache.
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.
S3DataRepositoryConfiguration s3
The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
List<E> tags
Date creationTime
String fileCacheId
The globally unique ID of the Amazon File Cache resource.
String fileCachePath
A path on the Amazon File Cache that points to a high-level directory (such as /ns1/) or
subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath.
The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache
paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link
another data repository with cache path /ns1/ns2.
This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is
specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
List<E> dataRepositorySubdirectories
For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the
subdirectories must be on a single NFS file system. The Export paths are in the format /exportpath1.
To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file
system. The NFS file system domain name in effect is the root of the subdirectories. Note that
DataRepositorySubdirectories is not supported for S3 data repositories.
NFSDataRepositoryConfiguration nFS
The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.
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.
FAILED - The data repository is in a terminal state that cannot be recovered.
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.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings
of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any
objects that were deleted in the 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 - The task has not started.
EXECUTING - The task is in process.
FAILED - The task was not able to be completed. For example, there may be files the task failed to
process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
SUCCEEDED - The task has completed successfully.
CANCELED - The task was canceled and it did not complete.
CANCELING - The task is in process of being canceled.
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 tasks export from your Amazon FSx for Lustre file system to a linked data
repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon
FSx for Lustre file system.
RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have
been exported to a linked S3 bucket and that meet your specified release criteria.
AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.
Date creationTime
Date startTime
The time the system began processing the task.
Date endTime
The time the system completed processing the task, populated after the task is complete.
String resourceARN
List<E> tags
String fileSystemId
The globally unique ID of the file system.
List<E> paths
An array of paths 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
Long capacityToRelease
Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
String fileCacheId
The system-generated, unique ID of the cache.
ReleaseConfiguration releaseConfiguration
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
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.
Long releasedCapacity
The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
String associationId
The ID of the data repository association that you want to delete.
String clientRequestToken
Boolean deleteDataInFileSystem
Set to true to delete the data in the file system that corresponds to the data repository
association.
String associationId
The ID of the data repository association being deleted.
String lifecycle
Describes the lifecycle state of the data repository association being deleted.
Boolean deleteDataInFileSystem
Indicates whether data in the file system that corresponds to the data repository association is being deleted.
Default is false.
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)
The fsx:CreateBackup permission is required if you set SkipFinalBackup to
false in order to delete the file system and take a final backup.
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.
Boolean skipFinalBackup
By default, Amazon FSx for OpenZFS 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 taking a final backup, set this value to true.
List<E> finalBackupTags
A list of tags to apply to the file system's final backup.
List<E> options
To delete a file system if there are child volumes present below the root volume, use the string
DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system has child volumes and you don't use this
option, the delete request will fail.
String fileSystemId
The ID of the file system that you want to delete.
String clientRequestToken
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
DeleteFileSystemWindowsConfiguration windowsConfiguration
DeleteFileSystemLustreConfiguration lustreConfiguration
DeleteFileSystemOpenZFSConfiguration openZFSConfiguration
The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.
String fileSystemId
The ID of the file system that's being deleted.
String lifecycle
The file system lifecycle for the deletion request. If the DeleteFileSystem operation is successful,
this status is DELETING.
DeleteFileSystemWindowsResponse windowsResponse
DeleteFileSystemLustreResponse lustreResponse
DeleteFileSystemOpenZFSResponse openZFSResponse
The response object for the OpenZFS file system that's being deleted in the DeleteFileSystem
operation.
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.
Boolean skipFinalBackup
Set to true if you want to skip taking a final backup of the volume you are deleting.
List<E> finalBackupTags
Boolean bypassSnaplockEnterpriseRetention
Setting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise
volume with unexpired write once, read many (WORM) files. The IAM permission
fsx:BypassSnaplockEnterpriseRetention is also required to delete SnapLock Enterprise volumes with
unexpired WORM files. The default value is false.
For more information, see Deleting a SnapLock volume.
String clientRequestToken
String volumeId
The ID of the volume that you are deleting.
DeleteVolumeOntapConfiguration ontapConfiguration
For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the
backup. To apply tags to the backup, you must have the fsx:TagResource permission.
DeleteVolumeOpenZFSConfiguration openZFSConfiguration
For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.
String volumeId
The ID of the volume that's being deleted.
String lifecycle
The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this
value is DELETING.
DeleteVolumeOntapResponse ontapResponse
Returned after a DeleteVolume request, showing the status of the delete request.
List<E> backupIds
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't
found, a BackupNotFound error occurs.
List<E> filters
The filters structure. The supported names are file-system-id, backup-type,
file-system-type, and volume-id.
Integer maxResults
Maximum number of backups to return in the response. 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
An opaque pagination token returned from a previous DescribeBackups operation. If a token is
present, the operation continues the list from where the returning call left off.
List<E> associationIds
IDs of the data repository associations whose descriptions you want to retrieve (String).
List<E> filters
Integer maxResults
The maximum number of resources to return in the response. This value must be an integer greater than zero.
String nextToken
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
String clientRequestToken
String fileSystemId
The ID of the file system to return the associated DNS aliases for (String).
Integer maxResults
Maximum number of DNS aliases 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 DescribeFileSystemAliases operation (String). If a
token is included in the request, the action continues the list from where the previous returning call left off.
List<E> aliases
An array of one or more DNS aliases currently associated with the specified file system.
String nextToken
Present if there are more DNS aliases than returned in the response (String). You can use the
NextToken value in a later request to fetch additional descriptions.
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 operation continues the list from where the returning call left off.
List<E> snapshotIds
The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't
found, a SnapshotNotFound error occurs.
List<E> filters
The filters structure. The supported names are file-system-id or volume-id.
Integer maxResults
String nextToken
String unit
The unit of time used by the Value parameter to determine if a file can be released, based on when
it was last accessed. DAYS is the only supported value. This is a required parameter.
Long value
An integer that represents the minimum amount of time (in days) since a file was last accessed in the file
system. Only exported files with a MAX(atime, ctime, mtime) timestamp that is more than this amount
of time in the past (relative to the task create time) will be released. The default of Value is
0. This is a required parameter.
If an exported file meets the last accessed time criteria, its file or directory path must also be specified in
the Paths parameter of the operation in order for the file to be released.
String ownerId
Date creationTime
String fileCacheId
The system-generated, unique ID of the cache.
String fileCacheType
The type of cache, which must be LUSTRE.
String fileCacheTypeVersion
The Lustre version of the cache, which must be 2.12.
String lifecycle
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
CREATING - The new cache is being created.
DELETING - An existing cache is being deleted.
UPDATING - The cache is undergoing a customer-initiated update.
FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the
cache was unable to be created.
FileCacheFailureDetails failureDetails
A structure providing details of any failures that occurred.
Integer storageCapacity
The storage capacity of the cache in gibibytes (GiB).
String vpcId
List<E> subnetIds
List<E> networkInterfaceIds
String dNSName
The Domain Name System (DNS) name for the cache.
String kmsKeyId
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more
information, see Encrypt in
the Key Management Service API Reference.
String resourceARN
FileCacheLustreConfiguration lustreConfiguration
The configuration for the Amazon File Cache resource.
List<E> dataRepositoryAssociationIds
A list of IDs of data repository associations that are associated with this cache.
String ownerId
Date creationTime
String fileCacheId
The system-generated, unique ID of the cache.
String fileCacheType
The type of cache, which must be LUSTRE.
String fileCacheTypeVersion
The Lustre version of the cache, which must be 2.12.
String lifecycle
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
CREATING - The new cache is being created.
DELETING - An existing cache is being deleted.
UPDATING - The cache is undergoing a customer-initiated update.
FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the
cache was unable to be created.
FileCacheFailureDetails failureDetails
A structure providing details of any failures that occurred.
Integer storageCapacity
The storage capacity of the cache in gibibytes (GiB).
String vpcId
List<E> subnetIds
List<E> networkInterfaceIds
String dNSName
The Domain Name System (DNS) name for the cache.
String kmsKeyId
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more
information, see Encrypt in
the Key Management Service API Reference.
String resourceARN
List<E> tags
Boolean copyTagsToDataRepositoryAssociations
A boolean flag indicating whether tags for the cache should be copied to data repository associations.
FileCacheLustreConfiguration lustreConfiguration
The configuration for the Amazon File Cache resource.
List<E> dataRepositoryAssociationIds
A list of IDs of data repository associations that are associated with this cache.
String fileCachePath
A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as
/ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward
slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example,
if a data repository is associated with cache path /ns1/, then you cannot link another data
repository with cache path /ns1/ns2.
This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is
specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
String dataRepositoryPath
The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:
The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export
directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can
therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS
file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories
specified with the DataRepositorySubdirectories parameter.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
List<E> dataRepositorySubdirectories
A list of NFS Exports that will be linked with this data repository association. The Export paths are in the
format /exportpath1. To use this parameter, you must configure DataRepositoryPath as
the domain name of the NFS file system. The NFS file system domain name in effect is the root of the
subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.
FileCacheNFSConfiguration nFS
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
String message
A message describing any failures that occurred.
Integer perUnitStorageThroughput
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of
storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput
(MB/s/TiB). The only supported value is 1000.
String deploymentType
The deployment type of the Amazon File Cache resource, which must be CACHE_1.
String mountName
You use the MountName value when mounting the cache. If you pass a cache ID to the
DescribeFileCaches operation, it returns the the MountName value as part of the cache's
description.
String weeklyMaintenanceStartTime
FileCacheLustreMetadataConfiguration metadataConfiguration
The configuration for a Lustre MDT (Metadata Target) storage volume.
LustreLogConfiguration logConfiguration
The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.
Integer storageCapacity
The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported
value is 2400 GiB.
String version
The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is
NFS3, which indicates that the data repository must support the NFSv3 protocol.
List<E> dnsIps
A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
String ownerId
The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services 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, which can be LUSTRE, WINDOWS, ONTAP,
or OPENZFS.
String lifecycle
The lifecycle status of the file system. The 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 - The file system is in a failed but recoverable state.
MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently
unavailable due to a change in your Active Directory configuration.
UPDATING - The file system is undergoing a customer-initiated update.
FileSystemFailureDetails failureDetails
Integer storageCapacity
The storage capacity of the file system in gibibytes (GiB).
String storageType
The type of storage the file system is using. 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 virtual private cloud (VPC) for the file system.
List<E> subnetIds
Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP
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 FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains
the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint
is available in the PreferredSubnetID.
List<E> networkInterfaceIds
The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (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 Domain Name System (DNS) name for the file system.
String kmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:
Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.
SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for
your account.
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
String resourceARN
The Amazon Resource Name (ARN) of 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 Amazon FSx for Windows File Server 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 Amazon FSx system that you have initiated using the
UpdateFileSystem operation.
OntapFileSystemConfiguration ontapConfiguration
The configuration for this Amazon FSx for NetApp ONTAP file system.
String fileSystemTypeVersion
The Lustre version of the Amazon FSx for Lustre file system, which is 2.10, 2.12, or
2.15.
OpenZFSFileSystemConfiguration openZFSConfiguration
The configuration for this Amazon FSx for OpenZFS file system.
FileSystemEndpoint intercluster
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
FileSystemEndpoint management
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
String message
A message describing any failures that occurred.
String parameter
A parameter that is incompatible with the earlier request.
String invalidSubnetId
The subnet ID that is either invalid or not part of the VPC specified.
String invalidSecurityGroupId
The security group ID is either invalid or not part of the VPC specified.
String invalidRouteTableId
The route table ID is either invalid or not part of the VPC specified.
String message
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. Here,
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 and PERSISTENT_2 deployment type is used for longer-term storage and
workloads and encryption of data in transit. PERSISTENT_2 offers higher
PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity
requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment
options.
The default is 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 and
PERSISTENT_2 deployment types.
Valid values:
For PERSISTENT_1 SSD storage: 50, 100, 200.
For PERSISTENT_1 HDD storage: 12, 40.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.
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, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is
a string that is unique within an Amazon Web Services Region.
String dailyAutomaticBackupStartTime
Integer automaticBackupRetentionDays
Boolean copyTagsToBackups
A boolean flag indicating whether tags on the file system are 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 StorageType is HDD. When set to READ the file
system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the
performance for frequently accessed files by caching up to 20% of the total storage capacity.
This parameter is required when StorageType is set to HDD.
String dataCompressionType
The data compression configuration for the file system. DataCompressionType can have the following
values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression.
LustreLogConfiguration logConfiguration
The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.
LustreRootSquashConfiguration rootSquashConfiguration
The Lustre root squash configuration for 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.
String level
The data repository events that are logged by Amazon FSx.
WARN_ONLY - only warning events are logged.
ERROR_ONLY - only error events are logged.
WARN_ERROR - both warning events and error events are logged.
DISABLED - logging of data repository events is turned off.
Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.
String destination
The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
String level
Sets which data repository events are logged by Amazon FSx.
WARN_ONLY - only warning events are logged.
ERROR_ONLY - only error events are logged.
WARN_ERROR - both warning events and error events are logged.
DISABLED - logging of data repository events is turned off.
String destination
The Amazon Resource Name (ARN) that specifies the destination of the logs.
The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
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 (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon
File Cache).
If Destination is provided and the resource does not exist, the request will fail with a
BadRequest error.
If Level is set to DISABLED, you cannot specify a destination in
Destination.
String rootSquash
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:
A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.
A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.
When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.
List<E> noSquashNids
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:
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).
An address range is described using a dash to separate the range (for example,
10.0.[2-10].[1-255]@tcp).
String version
The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported
value is NFS3, which indicates that the data repository must support the NFSv3 protocol.
List<E> dnsIps
A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
AutoExportPolicy autoExportPolicy
This parameter is not supported for Amazon File Cache.
String resourceARN
The Amazon Resource Name (ARN) of the non-Amazon FSx resource.
Integer automaticBackupRetentionDays
String dailyAutomaticBackupStartTime
String deploymentType
Specifies the FSx for ONTAP file system deployment type in use in the file system.
MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to
tolerate temporary Availability Zone (AZ) unavailability.
SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.
String endpointIpAddressRange
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
FileSystemEndpoints endpoints
The Management and Intercluster endpoints that are used to access data or to manage the
file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
DiskIopsConfiguration diskIopsConfiguration
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
String preferredSubnetId
List<E> routeTableIds
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
Integer throughputCapacity
String weeklyMaintenanceStartTime
String fsxAdminPassword
You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password
value is always redacted in the response.
String flexCacheEndpointType
Specifies the FlexCache endpoint type of the volume. Valid values are the following:
NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the
default.
ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
CACHE specifies that the volume is a FlexCache volume.
String junctionPath
Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the
storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a
JunctionPath directly below a parent volume junction or on a directory within a volume. A
JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or
/vol1/dir2/vol3, or even /dir1/dir2/vol3.
String securityStyle
The security style for the volume, which can be UNIX, NTFS, or MIXED.
Integer sizeInMegabytes
The configured size of the volume, in megabytes (MBs).
Boolean storageEfficiencyEnabled
The volume's storage efficiency setting.
String storageVirtualMachineId
The ID of the volume's storage virtual machine.
Boolean storageVirtualMachineRoot
A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one
volume on an SVM can be the root volume. This value defaults to false. If this value is
true, then this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag,
when set to false, helps you identify which volumes to delete before you can delete the SVM.
TieringPolicy tieringPolicy
The volume's TieringPolicy setting.
String uUID
The volume's universally unique identifier (UUID).
String ontapVolumeType
Specifies the type of volume. Valid values are the following:
RW specifies a read/write volume. RW is the default.
DP specifies a data-protection volume. You can protect data by replicating it to data-protection
mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a
FlexVol volume by providing additional read-only access to clients.
String snapshotPolicy
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the
hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of
two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only
retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent
automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
Boolean copyTagsToBackups
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.
SnaplockConfiguration snaplockConfiguration
The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
String clients
A value that specifies who can mount the file system. You can provide a wildcard character (*), an
IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the
wildcard character when specifying the client.
List<E> options
The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:
crossmnt is used by default. If you don't specify crossmnt when changing the client
configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
sync is used by default. If you instead specify async, the system acknowledges writes
before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
Integer recordSizeKiB
Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
String dataCompressionType
Specifies the method used to compress the data on the volume. The compression type is NONE by
default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
List<E> nfsExports
The configuration object for mounting a file system.
List<E> userAndGroupQuotas
An object specifying how much storage users or groups can use on the volume.
Boolean copyTagsToSnapshots
A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value
defaults to false. If it's set to true, all tags for the volume are copied to snapshots
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 snapshots. If you specify one or more tags when creating the snapshot, no tags
are copied from the volume, regardless of this value.
Boolean readOnly
A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful
after you have completed changes to a volume and no longer want changes to occur.
Integer automaticBackupRetentionDays
Boolean copyTagsToBackups
A Boolean value 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.
Boolean copyTagsToVolumes
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
String dailyAutomaticBackupStartTime
String deploymentType
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
MULTI_AZ_1,
SINGLE_AZ_1, and SINGLE_AZ_2.
Integer throughputCapacity
The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).
String weeklyMaintenanceStartTime
DiskIopsConfiguration diskIopsConfiguration
String rootVolumeId
The ID of the root volume of the OpenZFS file system.
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.
String endpointIpAddressRange
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
List<E> routeTableIds
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
String endpointIpAddress
The IP address of the endpoint that is used to access data or to manage the file system.
String snapshotARN
String copyStrategy
The strategy used when copying data from the snapshot to the new volume.
CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than
copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin
snapshot can't be deleted if there is a volume using its copied data.
FULL_COPY - Copies all data from the snapshot to the new volume.
String parentVolumeId
The ID of the parent volume.
String volumePath
The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
Integer storageCapacityReservationGiB
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
Integer storageCapacityQuotaGiB
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
Integer recordSizeKiB
The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
String dataCompressionType
Specifies the method used to compress the data on the volume. The compression type is NONE by
default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
Boolean copyTagsToSnapshots
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
OpenZFSOriginSnapshotConfiguration originSnapshot
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
Boolean readOnly
A Boolean value indicating whether the volume is read-only.
List<E> nfsExports
The configuration object for mounting a Network File System (NFS) file system.
List<E> userAndGroupQuotas
An object specifying how much storage users or groups can use on the volume.
String restoreToSnapshot
Specifies the ID of the snapshot to which the volume was restored.
Boolean deleteIntermediateSnaphots
A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.
Boolean deleteClonedVolumes
A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.
DurationSinceLastAccess durationSinceLastAccess
Defines the point-in-time since an exported file was last accessed, in order for that file to be eligible for release. Only files that were last accessed before this point-in-time are eligible to be released from the file system.
FileSystem fileSystem
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 clientRequestToken
String volumeId
The ID of the volume that you are restoring.
String snapshotId
The ID of the source snapshot. Specifies the snapshot that you are restoring from.
List<E> options
The settings used when restoring the specified volume from snapshot.
DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified
snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot
fails.
DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If
there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.
String volumeId
The ID of the volume that you restored.
String lifecycle
The lifecycle state of the volume being restored.
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 Amazon FSx system.
String type
Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid
types. If you set it to INFINITE, the files are retained forever. If you set it to
UNSPECIFIED, the files are retained until you set an explicit retention period.
Integer value
Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value
for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
Seconds: 0 - 65,535
Minutes: 0 - 65,535
Hours: 0 - 24
Days: 0 - 365
Months: 0 - 12
Years: 0 - 100
AutoImportPolicy autoImportPolicy
Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.
AutoExportPolicy autoExportPolicy
Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.
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 or ONTAP storage virtual machine (SVM) 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 three 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. 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 three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
String userName
Specifies the updated user name for the service account on your self-managed AD domain. Amazon FSx uses this account to join to your self-managed AD domain.
This account must have the permissions required to join computers to the domain in the organizational unit
provided in OrganizationalUnitDistinguishedName.
String password
Specifies the updated password for the service account on your self-managed AD domain. Amazon FSx uses this account to join to your self-managed AD domain.
List<E> dnsIps
A list of up to three DNS server or domain controller IP addresses in your self-managed AD domain.
String domainName
Specifies an updated fully qualified domain name of your self-managed AD configuration.
String organizationalUnitDistinguishedName
Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD.
String fileSystemAdministratorsGroup
Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges for the Amazon FSx resource.
String limit
Enumeration of the service limit that was exceeded.
Boolean auditLogVolume
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is
false. If you set AuditLogVolume to true, the SnapLock volume is created
as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
AutocommitPeriod autocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
String privilegedDelete
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if
they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete
is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.
For more information, see Privileged delete.
SnaplockRetentionPeriod retentionPeriod
Specifies the retention period of an FSx for ONTAP SnapLock volume.
String snaplockType
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:
COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be
deleted until their retention periods expire. This retention mode is used to address government or
industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.
ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users
before their retention periods expire using privileged delete. This retention mode is used to advance an
organization's data integrity and internal compliance or to test retention settings before using SnapLock
Compliance. For more information, see SnapLock Enterprise.
Boolean volumeAppendModeEnabled
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to
create WORM-appendable files and write data to them incrementally. The default value is false.
For more information, see Volume-append mode.
RetentionPeriod defaultRetention
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.
RetentionPeriod minimumRetention
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
RetentionPeriod maximumRetention
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
String resourceARN
String snapshotId
The ID of the snapshot.
String name
The name of the snapshot.
String volumeId
The ID of the volume that the snapshot is of.
Date creationTime
String lifecycle
The lifecycle status of the snapshot.
PENDING - Amazon FSx hasn't started creating the snapshot.
CREATING - Amazon FSx is creating the snapshot.
DELETING - Amazon FSx is deleting the snapshot.
AVAILABLE - The snapshot is fully available.
LifecycleTransitionReason lifecycleTransitionReason
List<E> tags
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 Amazon FSx system.
String backupId
SvmActiveDirectoryConfiguration activeDirectoryConfiguration
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
Date creationTime
SvmEndpoints endpoints
The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp
CloudManager. They are the Iscsi, Management, Nfs, and Smb
endpoints.
String fileSystemId
String lifecycle
Describes the SVM's lifecycle status.
CREATED - The SVM is fully available for use.
CREATING - Amazon FSx is creating the new SVM.
DELETING - Amazon FSx is deleting an existing SVM.
FAILED - Amazon FSx was unable to create the SVM.
MISCONFIGURED - The SVM is in a failed but recoverable state.
PENDING - Amazon FSx has not started creating the SVM.
String name
The name of the SVM, if provisioned.
String resourceARN
String storageVirtualMachineId
The SVM's system generated unique ID.
String subtype
Describes the SVM's subtype.
String uUID
The SVM's UUID (universally unique identifier).
List<E> tags
LifecycleTransitionReason lifecycleTransitionReason
Describes why the SVM lifecycle state changed.
String rootVolumeSecurityStyle
The security style of the root volume of the SVM.
String netBiosName
The NetBIOS name of the AD computer object to which the SVM is joined.
SelfManagedActiveDirectoryAttributes selfManagedActiveDirectoryConfiguration
SvmEndpoint iscsi
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
SvmEndpoint management
An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
SvmEndpoint nfs
An endpoint for connecting using the Network File System (NFS) protocol.
SvmEndpoint smb
An endpoint for connecting using the Server Message Block (SMB) protocol.
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.
Integer coolingPeriod
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and
moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies.
Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for
SNAPSHOT_ONLY.
String name
Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access
patterns.
ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage
pool tier.
NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the
capacity pool tier.
String associationId
The ID of the data repository association that you are updating.
String clientRequestToken
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.
S3DataRepositoryConfiguration s3
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
DataRepositoryAssociation association
The response object returned after the data repository association is updated.
String weeklyMaintenanceStartTime
String fileCacheId
The ID of the cache that you are updating.
String clientRequestToken
UpdateFileCacheLustreConfiguration lustreConfiguration
The configuration updates for an Amazon File Cache resource.
FileCache fileCache
A description of the cache that was updated.
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
The number of days to retain automatic backups. Setting this property to 0 disables automatic
backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
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.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings
of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any
objects that were deleted in the S3 bucket.
This parameter is not supported for file systems with a data repository association.
String dataCompressionType
Sets the data compression configuration for the file system. DataCompressionType can have the
following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
If you don't use DataCompressionType, the file system retains its current data compression
configuration.
For more information, see Lustre data compression.
LustreLogCreateConfiguration logConfiguration
The Lustre logging configuration used when updating 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.
LustreRootSquashConfiguration rootSquashConfiguration
The Lustre root squash configuration used when updating 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.
Integer automaticBackupRetentionDays
String dailyAutomaticBackupStartTime
String fsxAdminPassword
Update the password for the fsxadmin user by entering a new password. You use the
fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For
more information, see Managing resources
using NetApp Applicaton.
String weeklyMaintenanceStartTime
DiskIopsConfiguration diskIopsConfiguration
The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system.
The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The
configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case
of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see Updating SSD storage
capacity and IOPS.
Integer throughputCapacity
Enter a new value to change the amount of throughput capacity for the file system. Throughput capacity is measured in megabytes per second (MBps). Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps. For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.
List<E> addRouteTableIds
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
List<E> removeRouteTableIds
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
Integer automaticBackupRetentionDays
Boolean copyTagsToBackups
A Boolean value 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.
Boolean copyTagsToVolumes
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
String dailyAutomaticBackupStartTime
Integer throughputCapacity
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120,
7680, or 10240 MBps.
For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
String weeklyMaintenanceStartTime
DiskIopsConfiguration diskIopsConfiguration
List<E> addRouteTableIds
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system.
List<E> removeRouteTableIds
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
String fileSystemId
The ID of the file system that you are updating.
String clientRequestToken
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
Integer storageCapacity
Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.
You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Lustre file systems, the storage capacity target value can be the following:
For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid
values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per
TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be
greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.
For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.
For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.
For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
UpdateFileSystemWindowsConfiguration windowsConfiguration
The configuration updates for an Amazon FSx for Windows File Server file system.
UpdateFileSystemLustreConfiguration lustreConfiguration
UpdateFileSystemOntapConfiguration ontapConfiguration
UpdateFileSystemOpenZFSConfiguration openZFSConfiguration
The configuration updates for an FSx for OpenZFS file system.
String storageType
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 backups. Setting this property to 0 disables automatic
backups. You can retain automatic backups for a maximum of 90 days. The default is 30. 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.
WindowsAuditLogCreateConfiguration auditLogConfiguration
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system..
DiskIopsConfiguration diskIopsConfiguration
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
String junctionPath
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must
have a leading forward slash, such as /vol3.
String securityStyle
The security style for the volume, which can be UNIX, NTFS, or MIXED.
Integer sizeInMegabytes
Specifies the size of the volume in megabytes.
Boolean storageEfficiencyEnabled
Default is false. Set to true to enable the deduplication, compression, and compaction storage
efficiency features on the volume.
TieringPolicy tieringPolicy
Update the volume's data tiering policy.
String snapshotPolicy
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the
hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of
two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only
retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent
automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
Boolean copyTagsToBackups
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.
UpdateSnaplockConfiguration snaplockConfiguration
The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
Integer storageCapacityReservationGiB
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than
the parent volume has reserved. You can specify a value of -1 to unset a volume's storage capacity
reservation.
Integer storageCapacityQuotaGiB
The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota
larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's
storage capacity quota.
Integer recordSizeKiB
Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
String dataCompressionType
Specifies the method used to compress the data on the volume. The compression type is NONE by
default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
List<E> nfsExports
The configuration object for mounting a Network File System (NFS) file system.
List<E> userAndGroupQuotas
An object specifying how much storage users or groups can use on the volume.
Boolean readOnly
A Boolean value indicating whether the volume is read-only.
Boolean auditLogVolume
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is
false. If you set AuditLogVolume to true, the SnapLock volume is created
as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
AutocommitPeriod autocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
String privilegedDelete
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if
they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete
is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.
For more information, see Privileged delete.
SnaplockRetentionPeriod retentionPeriod
Specifies the retention period of an FSx for ONTAP SnapLock volume.
Boolean volumeAppendModeEnabled
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to
create WORM-appendable files and write data to them incrementally. The default value is false.
For more information, see Volume-append mode.
Snapshot snapshot
Returned after a successful UpdateSnapshot operation, describing the snapshot that you updated.
UpdateSvmActiveDirectoryConfiguration activeDirectoryConfiguration
Specifies updates to an SVM's Microsoft Active Directory (AD) configuration.
String clientRequestToken
String storageVirtualMachineId
The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.
String svmAdminPassword
Specifies a new SvmAdminPassword.
StorageVirtualMachine storageVirtualMachine
SelfManagedActiveDirectoryConfigurationUpdates selfManagedActiveDirectoryConfiguration
String netBiosName
Specifies an updated NetBIOS name of the AD computer object NetBiosName to which an SVM is joined.
String clientRequestToken
String volumeId
The ID of the volume that you want to update, in the format fsvol-0123456789abcdef0.
UpdateOntapVolumeConfiguration ontapConfiguration
The configuration of the ONTAP volume that you are updating.
String name
The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX. Child volume names
must be unique among their parent volume's children. The name of the volume is part of the mount string for the
OpenZFS volume.
UpdateOpenZFSVolumeConfiguration openZFSConfiguration
The configuration of the OpenZFS volume that you are updating.
Volume volume
A description of the volume just updated. Returned after a successful UpdateVolume API operation.
Date creationTime
String fileSystemId
String lifecycle
The lifecycle status of the volume.
AVAILABLE - The volume is fully available for use.
CREATED - The volume has been created.
CREATING - Amazon FSx is creating the new volume.
DELETING - Amazon FSx is deleting an existing volume.
FAILED - Amazon FSx was unable to create the volume.
MISCONFIGURED - The volume is in a failed but recoverable state.
PENDING - Amazon FSx hasn't started creating the volume.
String name
The name of the volume.
OntapVolumeConfiguration ontapConfiguration
String resourceARN
List<E> tags
String volumeId
The system-generated, unique ID of the volume.
String volumeType
The type of the volume.
LifecycleTransitionReason lifecycleTransitionReason
The reason why the volume lifecycle status changed.
List<E> administrativeActions
A list of administrative actions for the volume that are in process or waiting to be processed. Administrative
actions describe changes to the volume that you have initiated using the UpdateVolume action.
OpenZFSVolumeConfiguration openZFSConfiguration
The configuration of an Amazon FSx for OpenZFS volume.
String fileAccessAuditLogLevel
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are
logged.
DISABLED - access auditing of files and folders is turned off.
String fileShareAccessAuditLogLevel
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
String auditLogDestination
The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of
the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
String fileAccessAuditLogLevel
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are
logged.
DISABLED - access auditing of files and folders is turned off.
String fileShareAccessAuditLogLevel
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
String auditLogDestination
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:
The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of
the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.
If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log
stream in the CloudWatch Logs /aws/fsx/windows log group.
If AuditLogDestination is provided and the resource does not exist, the request will fail with a
BadRequest error.
If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to
DISABLED, you cannot specify a destination in AuditLogDestination.
String activeDirectoryId
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
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 the 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.
List<E> aliases
WindowsAuditLogConfiguration auditLogConfiguration
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
DiskIopsConfiguration diskIopsConfiguration
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
Copyright © 2023. All rights reserved.