Description Usage Arguments Value Request syntax Examples
View source: R/fsx_operations.R
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the
parameters match, this operation returns the description of the file
system. If a client request token specified by the file system exists
and the parameters don't match, this call returns
IncompatibleParameterError
. If a file system with the specified client
request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned
ID, and an initial lifecycle state of CREATING
.
Returns the description of the file system.
Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a
create_file_system_from_backup
call without the risk of creating an extra file system. This approach
can be useful when an initial call fails in a way that makes it unclear
whether a file system was created. Examples are if a transport level
timeout occurred, or your connection was reset. If you use the same
client request token and the initial call created a file system, the
client receives success as long as the parameters are the same.
The
create_file_system_from_backup
call returns while the file system's lifecycle state is still
CREATING
. You can check the file-system creation status by calling the
describe_file_systems
operation, which
returns the file system state along with other information.
1 2 3 | fsx_create_file_system_from_backup(BackupId, ClientRequestToken,
SubnetIds, SecurityGroupIds, Tags, WindowsConfiguration,
LustreConfiguration, StorageType)
|
BackupId |
[required] |
ClientRequestToken |
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. |
SubnetIds |
[required] Specifies the IDs of the subnets that the file system will be accessible
from. For Windows For Windows |
SecurityGroupIds |
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests. |
Tags |
The tags to be applied to the file system at file system creation. The
key value of the |
WindowsConfiguration |
The configuration for this Microsoft Windows file system. |
LustreConfiguration |
|
StorageType |
Sets the storage type for the Windows file system you're creating from a
backup. Valid values are
Default value is HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. |
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 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 | svc$create_file_system_from_backup(
BackupId = "string",
ClientRequestToken = "string",
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
WindowsConfiguration = list(
ActiveDirectoryId = "string",
SelfManagedActiveDirectoryConfiguration = list(
DomainName = "string",
OrganizationalUnitDistinguishedName = "string",
FileSystemAdministratorsGroup = "string",
UserName = "string",
Password = "string",
DnsIps = list(
"string"
)
),
DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2",
PreferredSubnetId = "string",
ThroughputCapacity = 123,
WeeklyMaintenanceStartTime = "string",
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = TRUE|FALSE,
Aliases = list(
"string"
)
),
LustreConfiguration = list(
WeeklyMaintenanceStartTime = "string",
ImportPath = "string",
ExportPath = "string",
ImportedFileChunkSize = 123,
DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1",
AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED",
PerUnitStorageThroughput = 123,
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = TRUE|FALSE,
DriveCacheType = "NONE"|"READ"
),
StorageType = "SSD"|"HDD"
)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | ## Not run:
# This operation creates a new file system from backup.
svc$create_file_system_from_backup(
BackupId = "backup-03e3c82e0183b7b6b",
ClientRequestToken = "f4c94ed7-238d-4c46-93db-48cd62ec33b7",
SecurityGroupIds = list(
"sg-edcd9784"
),
SubnetIds = list(
"subnet-1234abcd"
),
Tags = list(
list(
Key = "Name",
Value = "MyFileSystem"
)
),
WindowsConfiguration = list(
ThroughputCapacity = 8L
)
)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.