Description Usage Arguments Value Request syntax Examples
View source: R/fsx_operations.R
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:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
StorageCapacity
WeeklyMaintenanceStartTime
1 2 | fsx_update_file_system(FileSystemId, ClientRequestToken,
StorageCapacity, WindowsConfiguration, LustreConfiguration)
|
FileSystemId |
[required] Identifies the file system that you are updating. |
ClientRequestToken |
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 AWS Command Line Interface (AWS CLI) or an AWS SDK. |
StorageCapacity |
Use this parameter to increase the storage capacity of an Amazon FSx 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 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. |
WindowsConfiguration |
The configuration updates for an Amazon FSx for Windows File Server file system. |
LustreConfiguration |
A list with the following syntax:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | list(
FileSystem = list(
OwnerId = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
FileSystemId = "string",
FileSystemType = "WINDOWS"|"LUSTRE",
Lifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING",
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"
)
)
),
LustreConfiguration = list(
WeeklyMaintenanceStartTime = "string",
DataRepositoryConfiguration = list(
Lifecycle = "CREATING"|"AVAILABLE"|"MISCONFIGURED"|"UPDATING"|"DELETING",
ImportPath = "string",
ExportPath = "string",
ImportedFileChunkSize = 123,
AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED",
FailureDetails = list(
Message = "string"
)
),
DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1",
PerUnitStorageThroughput = 123,
MountName = "string",
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = TRUE|FALSE,
DriveCacheType = "NONE"|"READ"
),
AdministrativeActions = list(
list(
AdministrativeActionType = "FILE_SYSTEM_UPDATE"|"STORAGE_OPTIMIZATION"|"FILE_SYSTEM_ALIAS_ASSOCIATION"|"FILE_SYSTEM_ALIAS_DISASSOCIATION",
ProgressPercent = 123,
RequestTime = as.POSIXct(
"2015-01-01"
),
Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING",
TargetFileSystemValues = list(),
FailureDetails = list(
Message = "string"
)
)
)
)
)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | 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"
)
)
),
LustreConfiguration = list(
WeeklyMaintenanceStartTime = "string",
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED"
)
)
|
1 2 3 4 5 6 7 8 9 10 11 12 | ## 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)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.