UpdateFileSystem - Amazon FSx
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

UpdateFileSystem

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

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

  • AuditLogConfiguration

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • StorageType

  • ThroughputCapacity

  • DiskIopsConfiguration

  • WeeklyMaintenanceStartTime

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

  • AutoImportPolicy

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DataCompressionType

  • LogConfiguration

  • LustreRootSquashConfiguration

  • MetadataConfiguration

  • PerUnitStorageThroughput

  • StorageCapacity

  • WeeklyMaintenanceStartTime

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

  • AddRouteTableIds

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DiskIopsConfiguration

  • FsxAdminPassword

  • HAPairs

  • RemoveRouteTableIds

  • StorageCapacity

  • ThroughputCapacity

  • ThroughputCapacityPerHAPair

  • WeeklyMaintenanceStartTime

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

  • AddRouteTableIds

  • AutomaticBackupRetentionDays

  • CopyTagsToBackups

  • CopyTagsToVolumes

  • DailyAutomaticBackupStartTime

  • DiskIopsConfiguration

  • RemoveRouteTableIds

  • StorageCapacity

  • ThroughputCapacity

  • WeeklyMaintenanceStartTime

Request Syntax

{
   "ClientRequestToken": "string",
   "FileSystemId": "string",
   "LustreConfiguration": { 
      "AutoImportPolicy": "string",
      "AutomaticBackupRetentionDays": number,
      "DailyAutomaticBackupStartTime": "string",
      "DataCompressionType": "string",
      "LogConfiguration": { 
         "Destination": "string",
         "Level": "string"
      },
      "MetadataConfiguration": { 
         "Iops": number,
         "Mode": "string"
      },
      "PerUnitStorageThroughput": number,
      "RootSquashConfiguration": { 
         "NoSquashNids": [ "string" ],
         "RootSquash": "string"
      },
      "WeeklyMaintenanceStartTime": "string"
   },
   "OntapConfiguration": { 
      "AddRouteTableIds": [ "string" ],
      "AutomaticBackupRetentionDays": number,
      "DailyAutomaticBackupStartTime": "string",
      "DiskIopsConfiguration": { 
         "Iops": number,
         "Mode": "string"
      },
      "FsxAdminPassword": "string",
      "HAPairs": number,
      "RemoveRouteTableIds": [ "string" ],
      "ThroughputCapacity": number,
      "ThroughputCapacityPerHAPair": number,
      "WeeklyMaintenanceStartTime": "string"
   },
   "OpenZFSConfiguration": { 
      "AddRouteTableIds": [ "string" ],
      "AutomaticBackupRetentionDays": number,
      "CopyTagsToBackups": boolean,
      "CopyTagsToVolumes": boolean,
      "DailyAutomaticBackupStartTime": "string",
      "DiskIopsConfiguration": { 
         "Iops": number,
         "Mode": "string"
      },
      "RemoveRouteTableIds": [ "string" ],
      "ThroughputCapacity": number,
      "WeeklyMaintenanceStartTime": "string"
   },
   "StorageCapacity": number,
   "StorageType": "string",
   "WindowsConfiguration": { 
      "AuditLogConfiguration": { 
         "AuditLogDestination": "string",
         "FileAccessAuditLogLevel": "string",
         "FileShareAccessAuditLogLevel": "string"
      },
      "AutomaticBackupRetentionDays": number,
      "DailyAutomaticBackupStartTime": "string",
      "DiskIopsConfiguration": { 
         "Iops": number,
         "Mode": "string"
      },
      "SelfManagedActiveDirectoryConfiguration": { 
         "DnsIps": [ "string" ],
         "DomainName": "string",
         "FileSystemAdministratorsGroup": "string",
         "OrganizationalUnitDistinguishedName": "string",
         "Password": "string",
         "UserName": "string"
      },
      "ThroughputCapacity": number,
      "WeeklyMaintenanceStartTime": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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 AWS Command Line Interface (AWS CLI) or an AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

FileSystemId

The ID of the file system that you are updating.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 21.

Pattern: ^(fs-[0-9a-f]{8,})$

Required: Yes

LustreConfiguration

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

Type: UpdateFileSystemLustreConfiguration object

Required: No

OntapConfiguration

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

Type: UpdateFileSystemOntapConfiguration object

Required: No

OpenZFSConfiguration

The configuration updates for an FSx for OpenZFS file system.

Type: UpdateFileSystemOpenZFSConfiguration object

Required: No

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.

Note

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

Required: No

StorageType

Specifies the file system's storage type.

Type: String

Valid Values: SSD | HDD

Required: No

WindowsConfiguration

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

Type: UpdateFileSystemWindowsConfiguration object

Required: No

Response Syntax

{
   "FileSystem": { 
      "AdministrativeActions": [ 
         { 
            "AdministrativeActionType": "string",
            "FailureDetails": { 
               "Message": "string"
            },
            "ProgressPercent": number,
            "RemainingTransferBytes": number,
            "RequestTime": number,
            "Status": "string",
            "TargetFileSystemValues": "FileSystem",
            "TargetSnapshotValues": { 
               "AdministrativeActions": [ 
                  "AdministrativeAction"
               ],
               "CreationTime": number,
               "Lifecycle": "string",
               "LifecycleTransitionReason": { 
                  "Message": "string"
               },
               "Name": "string",
               "ResourceARN": "string",
               "SnapshotId": "string",
               "Tags": [ 
                  { 
                     "Key": "string",
                     "Value": "string"
                  }
               ],
               "VolumeId": "string"
            },
            "TargetVolumeValues": { 
               "AdministrativeActions": [ 
                  "AdministrativeAction"
               ],
               "CreationTime": number,
               "FileSystemId": "string",
               "Lifecycle": "string",
               "LifecycleTransitionReason": { 
                  "Message": "string"
               },
               "Name": "string",
               "OntapConfiguration": { 
                  "AggregateConfiguration": { 
                     "Aggregates": [ "string" ],
                     "TotalConstituents": number
                  },
                  "CopyTagsToBackups": boolean,
                  "FlexCacheEndpointType": "string",
                  "JunctionPath": "string",
                  "OntapVolumeType": "string",
                  "SecurityStyle": "string",
                  "SizeInBytes": number,
                  "SizeInMegabytes": number,
                  "SnaplockConfiguration": { 
                     "AuditLogVolume": boolean,
                     "AutocommitPeriod": { 
                        "Type": "string",
                        "Value": number
                     },
                     "PrivilegedDelete": "string",
                     "RetentionPeriod": { 
                        "DefaultRetention": { 
                           "Type": "string",
                           "Value": number
                        },
                        "MaximumRetention": { 
                           "Type": "string",
                           "Value": number
                        },
                        "MinimumRetention": { 
                           "Type": "string",
                           "Value": number
                        }
                     },
                     "SnaplockType": "string",
                     "VolumeAppendModeEnabled": boolean
                  },
                  "SnapshotPolicy": "string",
                  "StorageEfficiencyEnabled": boolean,
                  "StorageVirtualMachineId": "string",
                  "StorageVirtualMachineRoot": boolean,
                  "TieringPolicy": { 
                     "CoolingPeriod": number,
                     "Name": "string"
                  },
                  "UUID": "string",
                  "VolumeStyle": "string"
               },
               "OpenZFSConfiguration": { 
                  "CopyStrategy": "string",
                  "CopyTagsToSnapshots": boolean,
                  "DataCompressionType": "string",
                  "DeleteClonedVolumes": boolean,
                  "DeleteIntermediateData": boolean,
                  "DeleteIntermediateSnaphots": boolean,
                  "DestinationSnapshot": "string",
                  "NfsExports": [ 
                     { 
                        "ClientConfigurations": [ 
                           { 
                              "Clients": "string",
                              "Options": [ "string" ]
                           }
                        ]
                     }
                  ],
                  "OriginSnapshot": { 
                     "CopyStrategy": "string",
                     "SnapshotARN": "string"
                  },
                  "ParentVolumeId": "string",
                  "ReadOnly": boolean,
                  "RecordSizeKiB": number,
                  "RestoreToSnapshot": "string",
                  "SourceSnapshotARN": "string",
                  "StorageCapacityQuotaGiB": number,
                  "StorageCapacityReservationGiB": number,
                  "UserAndGroupQuotas": [ 
                     { 
                        "Id": number,
                        "StorageCapacityQuotaGiB": number,
                        "Type": "string"
                     }
                  ],
                  "VolumePath": "string"
               },
               "ResourceARN": "string",
               "Tags": [ 
                  { 
                     "Key": "string",
                     "Value": "string"
                  }
               ],
               "VolumeId": "string",
               "VolumeType": "string"
            },
            "TotalTransferBytes": number
         }
      ],
      "CreationTime": number,
      "DNSName": "string",
      "FailureDetails": { 
         "Message": "string"
      },
      "FileSystemId": "string",
      "FileSystemType": "string",
      "FileSystemTypeVersion": "string",
      "KmsKeyId": "string",
      "Lifecycle": "string",
      "LustreConfiguration": { 
         "AutomaticBackupRetentionDays": number,
         "CopyTagsToBackups": boolean,
         "DailyAutomaticBackupStartTime": "string",
         "DataCompressionType": "string",
         "DataRepositoryConfiguration": { 
            "AutoImportPolicy": "string",
            "ExportPath": "string",
            "FailureDetails": { 
               "Message": "string"
            },
            "ImportedFileChunkSize": number,
            "ImportPath": "string",
            "Lifecycle": "string"
         },
         "DeploymentType": "string",
         "DriveCacheType": "string",
         "LogConfiguration": { 
            "Destination": "string",
            "Level": "string"
         },
         "MetadataConfiguration": { 
            "Iops": number,
            "Mode": "string"
         },
         "MountName": "string",
         "PerUnitStorageThroughput": number,
         "RootSquashConfiguration": { 
            "NoSquashNids": [ "string" ],
            "RootSquash": "string"
         },
         "WeeklyMaintenanceStartTime": "string"
      },
      "NetworkInterfaceIds": [ "string" ],
      "OntapConfiguration": { 
         "AutomaticBackupRetentionDays": number,
         "DailyAutomaticBackupStartTime": "string",
         "DeploymentType": "string",
         "DiskIopsConfiguration": { 
            "Iops": number,
            "Mode": "string"
         },
         "EndpointIpAddressRange": "string",
         "Endpoints": { 
            "Intercluster": { 
               "DNSName": "string",
               "IpAddresses": [ "string" ]
            },
            "Management": { 
               "DNSName": "string",
               "IpAddresses": [ "string" ]
            }
         },
         "FsxAdminPassword": "string",
         "HAPairs": number,
         "PreferredSubnetId": "string",
         "RouteTableIds": [ "string" ],
         "ThroughputCapacity": number,
         "ThroughputCapacityPerHAPair": number,
         "WeeklyMaintenanceStartTime": "string"
      },
      "OpenZFSConfiguration": { 
         "AutomaticBackupRetentionDays": number,
         "CopyTagsToBackups": boolean,
         "CopyTagsToVolumes": boolean,
         "DailyAutomaticBackupStartTime": "string",
         "DeploymentType": "string",
         "DiskIopsConfiguration": { 
            "Iops": number,
            "Mode": "string"
         },
         "EndpointIpAddress": "string",
         "EndpointIpAddressRange": "string",
         "PreferredSubnetId": "string",
         "RootVolumeId": "string",
         "RouteTableIds": [ "string" ],
         "ThroughputCapacity": number,
         "WeeklyMaintenanceStartTime": "string"
      },
      "OwnerId": "string",
      "ResourceARN": "string",
      "StorageCapacity": number,
      "StorageType": "string",
      "SubnetIds": [ "string" ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "VpcId": "string",
      "WindowsConfiguration": { 
         "ActiveDirectoryId": "string",
         "Aliases": [ 
            { 
               "Lifecycle": "string",
               "Name": "string"
            }
         ],
         "AuditLogConfiguration": { 
            "AuditLogDestination": "string",
            "FileAccessAuditLogLevel": "string",
            "FileShareAccessAuditLogLevel": "string"
         },
         "AutomaticBackupRetentionDays": number,
         "CopyTagsToBackups": boolean,
         "DailyAutomaticBackupStartTime": "string",
         "DeploymentType": "string",
         "DiskIopsConfiguration": { 
            "Iops": number,
            "Mode": "string"
         },
         "MaintenanceOperationsInProgress": [ "string" ],
         "PreferredFileServerIp": "string",
         "PreferredSubnetId": "string",
         "RemoteAdministrationEndpoint": "string",
         "SelfManagedActiveDirectoryConfiguration": { 
            "DnsIps": [ "string" ],
            "DomainName": "string",
            "FileSystemAdministratorsGroup": "string",
            "OrganizationalUnitDistinguishedName": "string",
            "UserName": "string"
         },
         "ThroughputCapacity": number,
         "WeeklyMaintenanceStartTime": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileSystem

A description of the file system that was updated.

Type: FileSystem object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

FileSystemNotFound

No Amazon FSx file systems were found based upon supplied parameters.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

InvalidNetworkSettings

One or more network settings specified in the request are invalid.

HTTP Status Code: 400

MissingFileSystemConfiguration

A file system configuration is required for this operation.

HTTP Status Code: 400

ServiceLimitExceeded

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

HTTP Status Code: 400

UnsupportedOperation

The requested operation is not supported for this resource or API.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: