[ aws . fsx ]

update-file-system

Description

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.

For Amazon FSx for Windows File Server file systems, you can update the following properties:

  • AuditLogConfiguration

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • ThroughputCapacity

  • WeeklyMaintenanceStartTime

For Amazon FSx for Lustre file systems, you can update the following properties:

  • AutoImportPolicy

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DataCompressionType

  • StorageCapacity

  • WeeklyMaintenanceStartTime

For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • FsxAdminPassword

  • WeeklyMaintenanceStartTime

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-file-system
--file-system-id <value>
[--client-request-token <value>]
[--storage-capacity <value>]
[--windows-configuration <value>]
[--lustre-configuration <value>]
[--ontap-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--file-system-id (string)

Identifies the file system that you are updating.

--client-request-token (string)

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

--storage-capacity (integer)

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you’re updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

  • For SCRATCH_2 and PERSISTENT_1 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 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity.

  • For SCRATCH_1 file systems, you cannot increase the storage capacity.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .

--windows-configuration (structure)

The configuration updates for an Amazon FSx for Windows File Server file system.

WeeklyMaintenanceStartTime -> (string)

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.

DailyAutomaticBackupStartTime -> (string)

The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00

AutomaticBackupRetentionDays -> (integer)

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups .

ThroughputCapacity -> (integer)

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 .

SelfManagedActiveDirectoryConfiguration -> (structure)

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.

UserName -> (string)

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 .

Password -> (string)

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

DnsIps -> (list)

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

(string)

AuditLogConfiguration -> (structure)

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..

FileAccessAuditLogLevel -> (string)

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.

FileShareAccessAuditLogLevel -> (string)

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.

AuditLogDestination -> (string)

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 Firehouse 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 .

Shorthand Syntax:

WeeklyMaintenanceStartTime=string,DailyAutomaticBackupStartTime=string,AutomaticBackupRetentionDays=integer,ThroughputCapacity=integer,SelfManagedActiveDirectoryConfiguration={UserName=string,Password=string,DnsIps=[string,string]},AuditLogConfiguration={FileAccessAuditLogLevel=string,FileShareAccessAuditLogLevel=string,AuditLogDestination=string}

JSON Syntax:

{
  "WeeklyMaintenanceStartTime": "string",
  "DailyAutomaticBackupStartTime": "string",
  "AutomaticBackupRetentionDays": integer,
  "ThroughputCapacity": integer,
  "SelfManagedActiveDirectoryConfiguration": {
    "UserName": "string",
    "Password": "string",
    "DnsIps": ["string", ...]
  },
  "AuditLogConfiguration": {
    "FileAccessAuditLogLevel": "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
    "FileShareAccessAuditLogLevel": "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
    "AuditLogDestination": "string"
  }
}

--lustre-configuration (structure)

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

WeeklyMaintenanceStartTime -> (string)

(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.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

AutomaticBackupRetentionDays -> (integer)

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. The default is 0.

AutoImportPolicy -> (string)

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

For more information, see Automatically import updates from your S3 bucket .

DataCompressionType -> (string)

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 .

Shorthand Syntax:

WeeklyMaintenanceStartTime=string,DailyAutomaticBackupStartTime=string,AutomaticBackupRetentionDays=integer,AutoImportPolicy=string,DataCompressionType=string

JSON Syntax:

{
  "WeeklyMaintenanceStartTime": "string",
  "DailyAutomaticBackupStartTime": "string",
  "AutomaticBackupRetentionDays": integer,
  "AutoImportPolicy": "NONE"|"NEW"|"NEW_CHANGED",
  "DataCompressionType": "NONE"|"LZ4"
}

--ontap-configuration (structure)

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

AutomaticBackupRetentionDays -> (integer)

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. The default is 0.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

FsxAdminPassword -> (string)

The ONTAP administrative password for the fsxadmin user.

WeeklyMaintenanceStartTime -> (string)

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

Shorthand Syntax:

AutomaticBackupRetentionDays=integer,DailyAutomaticBackupStartTime=string,FsxAdminPassword=string,WeeklyMaintenanceStartTime=string

JSON Syntax:

{
  "AutomaticBackupRetentionDays": integer,
  "DailyAutomaticBackupStartTime": "string",
  "FsxAdminPassword": "string",
  "WeeklyMaintenanceStartTime": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

FileSystem -> (structure)

A description of the file system that was updated.

OwnerId -> (string)

The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.

CreationTime -> (timestamp)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The system-generated, unique 17-digit ID of the file system.

FileSystemType -> (string)

The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .

Lifecycle -> (string)

The lifecycle status of the file system, following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

  • CREATING - Amazon FSx is creating the new file system.

  • DELETING - Amazon FSx is deleting an existing file system.

  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.

  • UPDATING indicates that the file system is undergoing a customer initiated update.

FailureDetails -> (structure)

A structure providing details of any failures that occur when creating the file system has failed.

Message -> (string)

A message describing any failures that occurred during file system creation.

StorageCapacity -> (integer)

The storage capacity of the file system in gibibytes (GiB).

StorageType -> (string)

The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.

VpcId -> (string)

The ID of the primary VPC for the file system.

SubnetIds -> (list)

Specifies the IDs of the subnets that the file system is accessible from. For 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows and ONTAP file systems, the endpoint for the file system is available in the PreferredSubnetID .

(string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

NetworkInterfaceIds -> (list)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

(string)

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .

DNSName -> (string)

The DNS name for the file system.

KmsKeyId -> (string)

The ID of the Key Management Service (KMS) key used to encrypt the file system’s data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and persistent Amazon FSx for Lustre file systems at rest. If not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the Key Management Service API Reference .

ResourceARN -> (string)

The Amazon Resource Name (ARN) for the file system resource.

Tags -> (list)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

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 .

WindowsConfiguration -> (structure)

The configuration for this Microsoft Windows file system.

ActiveDirectoryId -> (string)

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

SelfManagedActiveDirectoryConfiguration -> (structure)

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

DomainName -> (string)

The fully qualified domain name of the self-managed AD directory.

OrganizationalUnitDistinguishedName -> (string)

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.

FileSystemAdministratorsGroup -> (string)

The name of the domain group whose members have administrative privileges for the FSx file system.

UserName -> (string)

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

DnsIps -> (list)

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

(string)

DeploymentType -> (string)

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 .

RemoteAdministrationEndpoint -> (string)

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.

PreferredSubnetId -> (string)

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 .

PreferredFileServerIp -> (string)

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 .

ThroughputCapacity -> (integer)

The throughput of the Amazon FSx file system, measured in megabytes per second.

MaintenanceOperationsInProgress -> (list)

The list of maintenance operations in progress for this file system.

(string)

An enumeration specifying the currently ongoing maintenance operation.

WeeklyMaintenanceStartTime -> (string)

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.

DailyAutomaticBackupStartTime -> (string)

The preferred time to take daily automatic backups, in the UTC time zone.

AutomaticBackupRetentionDays -> (integer)

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.

CopyTagsToBackups -> (boolean)

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.

Aliases -> (list)

An array of one or more DNS aliases that are currently associated 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 DNS aliases .

(structure)

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide .

Name -> (string)

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.

Lifecycle -> (string)

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.

AuditLogConfiguration -> (structure)

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.

FileAccessAuditLogLevel -> (string)

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.

FileShareAccessAuditLogLevel -> (string)

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.

AuditLogDestination -> (string)

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 Firehouse 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.

LustreConfiguration -> (structure)

The configuration for the Amazon FSx for Lustre file system.

WeeklyMaintenanceStartTime -> (string)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DataRepositoryConfiguration -> (structure)

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

Lifecycle -> (string)

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.

ImportPath -> (string)

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.

ExportPath -> (string)

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.

ImportedFileChunkSize -> (integer)

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.

AutoImportPolicy -> (string)

Describes the file system’s linked S3 data repository’s AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

For more information, see Automatically import updates from your S3 bucket .

FailureDetails -> (structure)

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .

Message -> (string)

A detailed error message.

DeploymentType -> (string)

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1 .

The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )

PerUnitStorageThroughput -> (integer)

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.

Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.

MountName -> (string)

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always “fsx “. For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an Amazon Web Services Region.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

AutomaticBackupRetentionDays -> (integer)

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. The default is 0.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

DriveCacheType -> (string)

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.

This parameter is required when StorageType is set to HDD.

DataCompressionType -> (string)

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 .

AdministrativeActions -> (list)

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 file system that you have initiated using the UpdateFileSystem action.

(structure)

Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.

AdministrativeActionType -> (string)

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system’s storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.

    • For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.

    • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .

ProgressPercent -> (integer)

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.

RequestTime -> (timestamp)

Time that the administrative action request was received.

Status -> (string)

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

  • UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .

TargetFileSystemValues -> (structure)

Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

OwnerId -> (string)

The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.

CreationTime -> (timestamp)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The system-generated, unique 17-digit ID of the file system.

FileSystemType -> (string)

The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .

Lifecycle -> (string)

The lifecycle status of the file system, following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

  • CREATING - Amazon FSx is creating the new file system.

  • DELETING - Amazon FSx is deleting an existing file system.

  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.

  • UPDATING indicates that the file system is undergoing a customer initiated update.

FailureDetails -> (structure)

A structure providing details of any failures that occur when creating the file system has failed.

Message -> (string)

A message describing any failures that occurred during file system creation.

StorageCapacity -> (integer)

The storage capacity of the file system in gibibytes (GiB).

StorageType -> (string)

The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.

VpcId -> (string)

The ID of the primary VPC for the file system.

SubnetIds -> (list)

Specifies the IDs of the subnets that the file system is accessible from. For 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows and ONTAP file systems, the endpoint for the file system is available in the PreferredSubnetID .

(string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

NetworkInterfaceIds -> (list)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

(string)

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .

DNSName -> (string)

The DNS name for the file system.

KmsKeyId -> (string)

The ID of the Key Management Service (KMS) key used to encrypt the file system’s data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and persistent Amazon FSx for Lustre file systems at rest. If not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the Key Management Service API Reference .

ResourceARN -> (string)

The Amazon Resource Name (ARN) for the file system resource.

Tags -> (list)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

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 .

WindowsConfiguration -> (structure)

The configuration for this Microsoft Windows file system.

ActiveDirectoryId -> (string)

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

SelfManagedActiveDirectoryConfiguration -> (structure)

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

DomainName -> (string)

The fully qualified domain name of the self-managed AD directory.

OrganizationalUnitDistinguishedName -> (string)

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.

FileSystemAdministratorsGroup -> (string)

The name of the domain group whose members have administrative privileges for the FSx file system.

UserName -> (string)

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

DnsIps -> (list)

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

(string)

DeploymentType -> (string)

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 .

RemoteAdministrationEndpoint -> (string)

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.

PreferredSubnetId -> (string)

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 .

PreferredFileServerIp -> (string)

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 .

ThroughputCapacity -> (integer)

The throughput of the Amazon FSx file system, measured in megabytes per second.

MaintenanceOperationsInProgress -> (list)

The list of maintenance operations in progress for this file system.

(string)

An enumeration specifying the currently ongoing maintenance operation.

WeeklyMaintenanceStartTime -> (string)

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.

DailyAutomaticBackupStartTime -> (string)

The preferred time to take daily automatic backups, in the UTC time zone.

AutomaticBackupRetentionDays -> (integer)

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.

CopyTagsToBackups -> (boolean)

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.

Aliases -> (list)

An array of one or more DNS aliases that are currently associated 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 DNS aliases .

(structure)

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide .

Name -> (string)

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.

Lifecycle -> (string)

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.

AuditLogConfiguration -> (structure)

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.

FileAccessAuditLogLevel -> (string)

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.

FileShareAccessAuditLogLevel -> (string)

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.

AuditLogDestination -> (string)

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 Firehouse 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.

LustreConfiguration -> (structure)

The configuration for the Amazon FSx for Lustre file system.

WeeklyMaintenanceStartTime -> (string)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DataRepositoryConfiguration -> (structure)

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

Lifecycle -> (string)

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.

ImportPath -> (string)

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.

ExportPath -> (string)

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.

ImportedFileChunkSize -> (integer)

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.

AutoImportPolicy -> (string)

Describes the file system’s linked S3 data repository’s AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

For more information, see Automatically import updates from your S3 bucket .

FailureDetails -> (structure)

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .

Message -> (string)

A detailed error message.

DeploymentType -> (string)

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1 .

The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )

PerUnitStorageThroughput -> (integer)

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.

Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.

MountName -> (string)

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always “fsx “. For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an Amazon Web Services Region.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

AutomaticBackupRetentionDays -> (integer)

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. The default is 0.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

DriveCacheType -> (string)

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.

This parameter is required when StorageType is set to HDD.

DataCompressionType -> (string)

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 .

AdministrativeActions -> (list)

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 file system that you have initiated using the UpdateFileSystem action.

(structure)

Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.

AdministrativeActionType -> (string)

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system’s storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.

    • For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.

    • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .

ProgressPercent -> (integer)

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.

RequestTime -> (timestamp)

Time that the administrative action request was received.

Status -> (string)

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

  • UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .

( … recursive … )FailureDetails -> (structure)

Provides information about a failed administrative action.

Message -> (string)

Error message providing details about the failed administrative action.

TargetVolumeValues -> (structure)

Describes an Amazon FSx for NetApp ONTAP volume.

CreationTime -> (timestamp)

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The globally unique ID of the file system, assigned by Amazon FSx.

Lifecycle -> (string)

The lifecycle status of the volume.

  • CREATED - The volume is fully available for use.

  • 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 has not started creating the volume.

Name -> (string)

The name of the volume.

OntapConfiguration -> (structure)

The configuration of an Amazon FSx for NetApp ONTAP volume

FlexCacheEndpointType -> (string)

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.

JunctionPath -> (string)

Specifies the directory that NAS clients use to mount the volume, along with the SVM 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..

SecurityStyle -> (string)

The security style for the volume, which can be UNIX , NTFS , or MIXED .

SizeInMegabytes -> (integer)

The configured size of the volume, in megabytes (MBs).

StorageEfficiencyEnabled -> (boolean)

The volume’s storage efficiency setting.

StorageVirtualMachineId -> (string)

The ID of the volume’s storage virtual machine.

StorageVirtualMachineRoot -> (boolean)

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 -> (structure)

The volume’s TieringPolicy setting.

CoolingPeriod -> (integer)

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 .

Name -> (string)

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.

UUID -> (string)

The volume’s UUID (universally unique identifier).

OntapVolumeType -> (string)

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 and use data protection mirror copies to recover data when a disaster occurs.

  • 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.

ResourceARN -> (string)

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Tags -> (list)

A list of Tag values, with a maximum of 50 elements.

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

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 .

VolumeId -> (string)

The system-generated, unique ID of the volume.

VolumeType -> (string)

The type of volume; ONTAP is the only valid volume type.

LifecycleTransitionReason -> (structure)

Describes why the volume lifecycle state changed.

Message -> (string)

A detailed error message.

OntapConfiguration -> (structure)

The configuration for this FSx for NetApp ONTAP file system.

AutomaticBackupRetentionDays -> (integer)

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. The default is 0.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DeploymentType -> (string)

The ONTAP file system deployment type.

EndpointIpAddressRange -> (string)

The IP address range in which the endpoints to access your file system are created.

Endpoints -> (structure)

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.

Intercluster -> (structure)

An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

DNSName -> (string)

The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

IpAddresses -> (list)

IP addresses of the file system endpoint.

(string)

Management -> (structure)

An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

DNSName -> (string)

The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

IpAddresses -> (list)

IP addresses of the file system endpoint.

(string)

DiskIopsConfiguration -> (structure)

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

Mode -> (string)

Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).

Iops -> (long)

The total number of SSD IOPS provisioned for the file system.

PreferredSubnetId -> (string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

RouteTableIds -> (list)

The VPC route tables in which your file system’s endpoints are created.

(string)

ThroughputCapacity -> (integer)

Sustained throughput of an Amazon FSx file system in MBps.

WeeklyMaintenanceStartTime -> (string)

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

FileSystemTypeVersion -> (string)

The version of your Amazon FSx for Lustre file system, either 2.10 or 2.12 .

FailureDetails -> (structure)

Provides information about a failed administrative action.

Message -> (string)

Error message providing details about the failed administrative action.

TargetVolumeValues -> (structure)

Describes an Amazon FSx for NetApp ONTAP volume.

CreationTime -> (timestamp)

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The globally unique ID of the file system, assigned by Amazon FSx.

Lifecycle -> (string)

The lifecycle status of the volume.

  • CREATED - The volume is fully available for use.

  • 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 has not started creating the volume.

Name -> (string)

The name of the volume.

OntapConfiguration -> (structure)

The configuration of an Amazon FSx for NetApp ONTAP volume

FlexCacheEndpointType -> (string)

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.

JunctionPath -> (string)

Specifies the directory that NAS clients use to mount the volume, along with the SVM 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..

SecurityStyle -> (string)

The security style for the volume, which can be UNIX , NTFS , or MIXED .

SizeInMegabytes -> (integer)

The configured size of the volume, in megabytes (MBs).

StorageEfficiencyEnabled -> (boolean)

The volume’s storage efficiency setting.

StorageVirtualMachineId -> (string)

The ID of the volume’s storage virtual machine.

StorageVirtualMachineRoot -> (boolean)

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 -> (structure)

The volume’s TieringPolicy setting.

CoolingPeriod -> (integer)

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 .

Name -> (string)

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.

UUID -> (string)

The volume’s UUID (universally unique identifier).

OntapVolumeType -> (string)

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 and use data protection mirror copies to recover data when a disaster occurs.

  • 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.

ResourceARN -> (string)

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Tags -> (list)

A list of Tag values, with a maximum of 50 elements.

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

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 .

VolumeId -> (string)

The system-generated, unique ID of the volume.

VolumeType -> (string)

The type of volume; ONTAP is the only valid volume type.

LifecycleTransitionReason -> (structure)

Describes why the volume lifecycle state changed.

Message -> (string)

A detailed error message.

OntapConfiguration -> (structure)

The configuration for this FSx for NetApp ONTAP file system.

AutomaticBackupRetentionDays -> (integer)

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. The default is 0.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DeploymentType -> (string)

The ONTAP file system deployment type.

EndpointIpAddressRange -> (string)

The IP address range in which the endpoints to access your file system are created.

Endpoints -> (structure)

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.

Intercluster -> (structure)

An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

DNSName -> (string)

The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

IpAddresses -> (list)

IP addresses of the file system endpoint.

(string)

Management -> (structure)

An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

DNSName -> (string)

The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

IpAddresses -> (list)

IP addresses of the file system endpoint.

(string)

DiskIopsConfiguration -> (structure)

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

Mode -> (string)

Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).

Iops -> (long)

The total number of SSD IOPS provisioned for the file system.

PreferredSubnetId -> (string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

RouteTableIds -> (list)

The VPC route tables in which your file system’s endpoints are created.

(string)

ThroughputCapacity -> (integer)

Sustained throughput of an Amazon FSx file system in MBps.

WeeklyMaintenanceStartTime -> (string)

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

FileSystemTypeVersion -> (string)

The version of your Amazon FSx for Lustre file system, either 2.10 or 2.12 .