Update File System

efs_update_file_system

R Documentation

Updates the throughput mode or the amount of provisioned throughput of an existing file system

Description

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Usage

efs_update_file_system(FileSystemId, ThroughputMode,
  ProvisionedThroughputInMibps)

Arguments

FileSystemId

[required] The ID of the file system that you want to update.

ThroughputMode

(Optional) Updates the file system's throughput mode. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.

ProvisionedThroughputInMibps

(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

Value

A list with the following syntax:

list(
  OwnerId = "string",
  CreationToken = "string",
  FileSystemId = "string",
  FileSystemArn = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LifeCycleState = "creating"|"available"|"updating"|"deleting"|"deleted"|"error",
  Name = "string",
  NumberOfMountTargets = 123,
  SizeInBytes = list(
    Value = 123,
    Timestamp = as.POSIXct(
      "2015-01-01"
    ),
    ValueInIA = 123,
    ValueInStandard = 123,
    ValueInArchive = 123
  ),
  PerformanceMode = "generalPurpose"|"maxIO",
  Encrypted = TRUE|FALSE,
  KmsKeyId = "string",
  ThroughputMode = "bursting"|"provisioned"|"elastic",
  ProvisionedThroughputInMibps = 123.0,
  AvailabilityZoneName = "string",
  AvailabilityZoneId = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  FileSystemProtection = list(
    ReplicationOverwriteProtection = "ENABLED"|"DISABLED"|"REPLICATING"
  )
)

Request syntax

svc$update_file_system(
  FileSystemId = "string",
  ThroughputMode = "bursting"|"provisioned"|"elastic",
  ProvisionedThroughputInMibps = 123.0
)