Update File System

fsx_update_file_system

R Documentation

Use this operation to update the configuration of an existing Amazon FSx 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 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

Usage

fsx_update_file_system(FileSystemId, ClientRequestToken,
  StorageCapacity, WindowsConfiguration, LustreConfiguration,
  OntapConfiguration, OpenZFSConfiguration, StorageType)

Arguments

FileSystemId

[required] The ID of the file system that you are updating.

ClientRequestToken

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

StorageCapacity

Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

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

• For SCRATCH_2, PERSISTENT_1, and ⁠PERSISTENT_2 SSD⁠ deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For ⁠PERSISTENT HDD⁠ file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

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

For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.

For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

WindowsConfiguration

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

LustreConfiguration

OntapConfiguration

OpenZFSConfiguration

The configuration updates for an FSx for OpenZFS file system.

StorageType

Value

A list with the following syntax:

list(
  FileSystem = list(
    OwnerId = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    FileSystemId = "string",
    FileSystemType = "WINDOWS"|"LUSTRE"|"ONTAP"|"OPENZFS",
    Lifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING"|"MISCONFIGURED_UNAVAILABLE",
    FailureDetails = list(
      Message = "string"
    ),
    StorageCapacity = 123,
    StorageType = "SSD"|"HDD",
    VpcId = "string",
    SubnetIds = list(
      "string"
    ),
    NetworkInterfaceIds = list(
      "string"
    ),
    DNSName = "string",
    KmsKeyId = "string",
    ResourceARN = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    WindowsConfiguration = list(
      ActiveDirectoryId = "string",
      SelfManagedActiveDirectoryConfiguration = list(
        DomainName = "string",
        OrganizationalUnitDistinguishedName = "string",
        FileSystemAdministratorsGroup = "string",
        UserName = "string",
        DnsIps = list(
          "string"
        )
      ),
      DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2",
      RemoteAdministrationEndpoint = "string",
      PreferredSubnetId = "string",
      PreferredFileServerIp = "string",
      ThroughputCapacity = 123,
      MaintenanceOperationsInProgress = list(
        "PATCHING"|"BACKING_UP"
      ),
      WeeklyMaintenanceStartTime = "string",
      DailyAutomaticBackupStartTime = "string",
      AutomaticBackupRetentionDays = 123,
      CopyTagsToBackups = TRUE|FALSE,
      Aliases = list(
        list(
          Name = "string",
          Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"
        )
      ),
      AuditLogConfiguration = list(
        FileAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
        FileShareAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
        AuditLogDestination = "string"
      ),
      DiskIopsConfiguration = list(
        Mode = "AUTOMATIC"|"USER_PROVISIONED",
        Iops = 123
      )
    ),
    LustreConfiguration = list(
      WeeklyMaintenanceStartTime = "string",
      DataRepositoryConfiguration = list(
        Lifecycle = "CREATING"|"AVAILABLE"|"MISCONFIGURED"|"UPDATING"|"DELETING"|"FAILED",
        ImportPath = "string",
        ExportPath = "string",
        ImportedFileChunkSize = 123,
        AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED"|"NEW_CHANGED_DELETED",
        FailureDetails = list(
          Message = "string"
        )
      ),
      DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1"|"PERSISTENT_2",
      PerUnitStorageThroughput = 123,
      MountName = "string",
      DailyAutomaticBackupStartTime = "string",
      AutomaticBackupRetentionDays = 123,
      CopyTagsToBackups = TRUE|FALSE,
      DriveCacheType = "NONE"|"READ",
      DataCompressionType = "NONE"|"LZ4",
      LogConfiguration = list(
        Level = "DISABLED"|"WARN_ONLY"|"ERROR_ONLY"|"WARN_ERROR",
        Destination = "string"
      ),
      RootSquashConfiguration = list(
        RootSquash = "string",
        NoSquashNids = list(
          "string"
        )
      ),
      MetadataConfiguration = list(
        Iops = 123,
        Mode = "AUTOMATIC"|"USER_PROVISIONED"
      )
    ),
    AdministrativeActions = list(
      list(
        AdministrativeActionType = "FILE_SYSTEM_UPDATE"|"STORAGE_OPTIMIZATION"|"FILE_SYSTEM_ALIAS_ASSOCIATION"|"FILE_SYSTEM_ALIAS_DISASSOCIATION"|"VOLUME_UPDATE"|"SNAPSHOT_UPDATE"|"RELEASE_NFS_V3_LOCKS"|"VOLUME_RESTORE"|"THROUGHPUT_OPTIMIZATION"|"IOPS_OPTIMIZATION"|"STORAGE_TYPE_OPTIMIZATION"|"MISCONFIGURED_STATE_RECOVERY"|"VOLUME_UPDATE_WITH_SNAPSHOT"|"VOLUME_INITIALIZE_WITH_SNAPSHOT"|"DOWNLOAD_DATA_FROM_BACKUP",
        ProgressPercent = 123,
        RequestTime = as.POSIXct(
          "2015-01-01"
        ),
        Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING"|"OPTIMIZING",
        TargetFileSystemValues = list(),
        FailureDetails = list(
          Message = "string"
        ),
        TargetVolumeValues = list(
          CreationTime = as.POSIXct(
            "2015-01-01"
          ),
          FileSystemId = "string",
          Lifecycle = "CREATING"|"CREATED"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|"AVAILABLE",
          Name = "string",
          OntapConfiguration = list(
            FlexCacheEndpointType = "NONE"|"ORIGIN"|"CACHE",
            JunctionPath = "string",
            SecurityStyle = "UNIX"|"NTFS"|"MIXED",
            SizeInMegabytes = 123,
            StorageEfficiencyEnabled = TRUE|FALSE,
            StorageVirtualMachineId = "string",
            StorageVirtualMachineRoot = TRUE|FALSE,
            TieringPolicy = list(
              CoolingPeriod = 123,
              Name = "SNAPSHOT_ONLY"|"AUTO"|"ALL"|"NONE"
            ),
            UUID = "string",
            OntapVolumeType = "RW"|"DP"|"LS",
            SnapshotPolicy = "string",
            CopyTagsToBackups = TRUE|FALSE,
            SnaplockConfiguration = list(
              AuditLogVolume = TRUE|FALSE,
              AutocommitPeriod = list(
                Type = "MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"NONE",
                Value = 123
              ),
              PrivilegedDelete = "DISABLED"|"ENABLED"|"PERMANENTLY_DISABLED",
              RetentionPeriod = list(
                DefaultRetention = list(
                  Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
                  Value = 123
                ),
                MinimumRetention = list(
                  Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
                  Value = 123
                ),
                MaximumRetention = list(
                  Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
                  Value = 123
                )
              ),
              SnaplockType = "COMPLIANCE"|"ENTERPRISE",
              VolumeAppendModeEnabled = TRUE|FALSE
            ),
            VolumeStyle = "FLEXVOL"|"FLEXGROUP",
            AggregateConfiguration = list(
              Aggregates = list(
                "string"
              ),
              TotalConstituents = 123
            ),
            SizeInBytes = 123
          ),
          ResourceARN = "string",
          Tags = list(
            list(
              Key = "string",
              Value = "string"
            )
          ),
          VolumeId = "string",
          VolumeType = "ONTAP"|"OPENZFS",
          LifecycleTransitionReason = list(
            Message = "string"
          ),
          AdministrativeActions = list(),
          OpenZFSConfiguration = list(
            ParentVolumeId = "string",
            VolumePath = "string",
            StorageCapacityReservationGiB = 123,
            StorageCapacityQuotaGiB = 123,
            RecordSizeKiB = 123,
            DataCompressionType = "NONE"|"ZSTD"|"LZ4",
            CopyTagsToSnapshots = TRUE|FALSE,
            OriginSnapshot = list(
              SnapshotARN = "string",
              CopyStrategy = "CLONE"|"FULL_COPY"|"INCREMENTAL_COPY"
            ),
            ReadOnly = TRUE|FALSE,
            NfsExports = list(
              list(
                ClientConfigurations = list(
                  list(
                    Clients = "string",
                    Options = list(
                      "string"
                    )
                  )
                )
              )
            ),
            UserAndGroupQuotas = list(
              list(
                Type = "USER"|"GROUP",
                Id = 123,
                StorageCapacityQuotaGiB = 123
              )
            ),
            RestoreToSnapshot = "string",
            DeleteIntermediateSnaphots = TRUE|FALSE,
            DeleteClonedVolumes = TRUE|FALSE,
            DeleteIntermediateData = TRUE|FALSE,
            SourceSnapshotARN = "string",
            DestinationSnapshot = "string",
            CopyStrategy = "CLONE"|"FULL_COPY"|"INCREMENTAL_COPY"
          )
        ),
        TargetSnapshotValues = list(
          ResourceARN = "string",
          SnapshotId = "string",
          Name = "string",
          VolumeId = "string",
          CreationTime = as.POSIXct(
            "2015-01-01"
          ),
          Lifecycle = "PENDING"|"CREATING"|"DELETING"|"AVAILABLE",
          LifecycleTransitionReason = list(
            Message = "string"
          ),
          Tags = list(
            list(
              Key = "string",
              Value = "string"
            )
          ),
          AdministrativeActions = list()
        ),
        TotalTransferBytes = 123,
        RemainingTransferBytes = 123
      )
    ),
    OntapConfiguration = list(
      AutomaticBackupRetentionDays = 123,
      DailyAutomaticBackupStartTime = "string",
      DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2"|"MULTI_AZ_2",
      EndpointIpAddressRange = "string",
      Endpoints = list(
        Intercluster = list(
          DNSName = "string",
          IpAddresses = list(
            "string"
          )
        ),
        Management = list(
          DNSName = "string",
          IpAddresses = list(
            "string"
          )
        )
      ),
      DiskIopsConfiguration = list(
        Mode = "AUTOMATIC"|"USER_PROVISIONED",
        Iops = 123
      ),
      PreferredSubnetId = "string",
      RouteTableIds = list(
        "string"
      ),
      ThroughputCapacity = 123,
      WeeklyMaintenanceStartTime = "string",
      FsxAdminPassword = "string",
      HAPairs = 123,
      ThroughputCapacityPerHAPair = 123
    ),
    FileSystemTypeVersion = "string",
    OpenZFSConfiguration = list(
      AutomaticBackupRetentionDays = 123,
      CopyTagsToBackups = TRUE|FALSE,
      CopyTagsToVolumes = TRUE|FALSE,
      DailyAutomaticBackupStartTime = "string",
      DeploymentType = "SINGLE_AZ_1"|"SINGLE_AZ_2"|"SINGLE_AZ_HA_1"|"SINGLE_AZ_HA_2"|"MULTI_AZ_1",
      ThroughputCapacity = 123,
      WeeklyMaintenanceStartTime = "string",
      DiskIopsConfiguration = list(
        Mode = "AUTOMATIC"|"USER_PROVISIONED",
        Iops = 123
      ),
      RootVolumeId = "string",
      PreferredSubnetId = "string",
      EndpointIpAddressRange = "string",
      RouteTableIds = list(
        "string"
      ),
      EndpointIpAddress = "string"
    )
  )
)

Request syntax

svc$update_file_system(
  FileSystemId = "string",
  ClientRequestToken = "string",
  StorageCapacity = 123,
  WindowsConfiguration = list(
    WeeklyMaintenanceStartTime = "string",
    DailyAutomaticBackupStartTime = "string",
    AutomaticBackupRetentionDays = 123,
    ThroughputCapacity = 123,
    SelfManagedActiveDirectoryConfiguration = list(
      UserName = "string",
      Password = "string",
      DnsIps = list(
        "string"
      ),
      DomainName = "string",
      OrganizationalUnitDistinguishedName = "string",
      FileSystemAdministratorsGroup = "string"
    ),
    AuditLogConfiguration = list(
      FileAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
      FileShareAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
      AuditLogDestination = "string"
    ),
    DiskIopsConfiguration = list(
      Mode = "AUTOMATIC"|"USER_PROVISIONED",
      Iops = 123
    )
  ),
  LustreConfiguration = list(
    WeeklyMaintenanceStartTime = "string",
    DailyAutomaticBackupStartTime = "string",
    AutomaticBackupRetentionDays = 123,
    AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED"|"NEW_CHANGED_DELETED",
    DataCompressionType = "NONE"|"LZ4",
    LogConfiguration = list(
      Level = "DISABLED"|"WARN_ONLY"|"ERROR_ONLY"|"WARN_ERROR",
      Destination = "string"
    ),
    RootSquashConfiguration = list(
      RootSquash = "string",
      NoSquashNids = list(
        "string"
      )
    ),
    PerUnitStorageThroughput = 123,
    MetadataConfiguration = list(
      Iops = 123,
      Mode = "AUTOMATIC"|"USER_PROVISIONED"
    )
  ),
  OntapConfiguration = list(
    AutomaticBackupRetentionDays = 123,
    DailyAutomaticBackupStartTime = "string",
    FsxAdminPassword = "string",
    WeeklyMaintenanceStartTime = "string",
    DiskIopsConfiguration = list(
      Mode = "AUTOMATIC"|"USER_PROVISIONED",
      Iops = 123
    ),
    ThroughputCapacity = 123,
    AddRouteTableIds = list(
      "string"
    ),
    RemoveRouteTableIds = list(
      "string"
    ),
    ThroughputCapacityPerHAPair = 123,
    HAPairs = 123
  ),
  OpenZFSConfiguration = list(
    AutomaticBackupRetentionDays = 123,
    CopyTagsToBackups = TRUE|FALSE,
    CopyTagsToVolumes = TRUE|FALSE,
    DailyAutomaticBackupStartTime = "string",
    ThroughputCapacity = 123,
    WeeklyMaintenanceStartTime = "string",
    DiskIopsConfiguration = list(
      Mode = "AUTOMATIC"|"USER_PROVISIONED",
      Iops = 123
    ),
    AddRouteTableIds = list(
      "string"
    ),
    RemoveRouteTableIds = list(
      "string"
    )
  ),
  StorageType = "SSD"|"HDD"
)

Examples

## Not run: 
# This operation updates an existing file system.
svc$update_file_system(
  FileSystemId = "fs-0498eed5fe91001ec",
  WindowsConfiguration = list(
    AutomaticBackupRetentionDays = 10L,
    DailyAutomaticBackupStartTime = "06:00",
    WeeklyMaintenanceStartTime = "3:06:00"
  )
)

## End(Not run)