Create File System
fsx_create_file_system | R Documentation |
Creates a new, empty Amazon FSx file system¶
Description¶
Creates a new, empty Amazon FSx file system. You can create the
following supported Amazon FSx file systems using the
create_file_system
API operation:
-
Amazon FSx for Lustre
-
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
This operation requires a client request token in the request that
Amazon FSx uses to ensure idempotent creation. This means that calling
the operation multiple times with the same client request token has no
effect. By using the idempotent operation, you can retry a
create_file_system
operation 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.
If a file system with the specified client request token exists and the
parameters match, create_file_system
returns the description of the
existing file system. If a file system with the specified client request
token exists and the parameters don't match, this call returns
IncompatibleParameterError
. If a file system with the specified client
request token doesn't exist, create_file_system
does the following:
-
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of
CREATING
. -
Returns the description of the file system in JSON format.
The create_file_system
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.
Usage¶
fsx_create_file_system(ClientRequestToken, FileSystemType,
StorageCapacity, StorageType, SubnetIds, SecurityGroupIds, Tags,
KmsKeyId, WindowsConfiguration, LustreConfiguration, OntapConfiguration,
FileSystemTypeVersion, OpenZFSConfiguration)
Arguments¶
ClientRequestToken |
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. |
FileSystemType |
[required] The type of Amazon FSx file system to create. Valid
values are |
StorageCapacity |
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB). FSx for Lustre file systems - The amount of storage
capacity that you can configure depends on the value that you set for
FSx for ONTAP file systems - The amount of storage
capacity that you can configure depends on the value of the
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). FSx for Windows File Server file systems - The
amount of storage capacity that you can configure depends on the value
that you set for
|
StorageType |
Sets the storage class for the file system that you're creating.
Valid values are
Default value is |
SubnetIds |
[required] Specifies the IDs of the subnets that the file system
will be accessible from. For Windows and ONTAP For Windows |
SecurityGroupIds |
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you. |
Tags |
The tags to apply to the file system that's being created. The
key value of the |
KmsKeyId |
|
WindowsConfiguration |
The Microsoft Windows configuration for the file system that's being created. |
LustreConfiguration |
|
OntapConfiguration |
|
FileSystemTypeVersion |
For FSx for Lustre file systems, sets the Lustre version for the
file system that you're creating. Valid values are
Default value is
|
OpenZFSConfiguration |
The OpenZFS configuration for the file system that's being created. |
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"|"INTELLIGENT_TIERING",
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"
),
EfaEnabled = TRUE|FALSE
),
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",
ReadCacheConfiguration = list(
SizingMode = "NO_CACHE"|"USER_PROVISIONED"|"PROPORTIONAL_TO_THROUGHPUT_CAPACITY",
SizeGiB = 123
)
)
)
)
Request syntax¶
svc$create_file_system(
ClientRequestToken = "string",
FileSystemType = "WINDOWS"|"LUSTRE"|"ONTAP"|"OPENZFS",
StorageCapacity = 123,
StorageType = "SSD"|"HDD"|"INTELLIGENT_TIERING",
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
KmsKeyId = "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"
),
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",
ImportPath = "string",
ExportPath = "string",
ImportedFileChunkSize = 123,
DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1"|"PERSISTENT_2",
AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED"|"NEW_CHANGED_DELETED",
PerUnitStorageThroughput = 123,
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = TRUE|FALSE,
DriveCacheType = "NONE"|"READ",
DataCompressionType = "NONE"|"LZ4",
EfaEnabled = TRUE|FALSE,
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"
)
),
OntapConfiguration = list(
AutomaticBackupRetentionDays = 123,
DailyAutomaticBackupStartTime = "string",
DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2"|"MULTI_AZ_2",
EndpointIpAddressRange = "string",
FsxAdminPassword = "string",
DiskIopsConfiguration = list(
Mode = "AUTOMATIC"|"USER_PROVISIONED",
Iops = 123
),
PreferredSubnetId = "string",
RouteTableIds = list(
"string"
),
ThroughputCapacity = 123,
WeeklyMaintenanceStartTime = "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
),
RootVolumeConfiguration = list(
RecordSizeKiB = 123,
DataCompressionType = "NONE"|"ZSTD"|"LZ4",
NfsExports = list(
list(
ClientConfigurations = list(
list(
Clients = "string",
Options = list(
"string"
)
)
)
)
),
UserAndGroupQuotas = list(
list(
Type = "USER"|"GROUP",
Id = 123,
StorageCapacityQuotaGiB = 123
)
),
CopyTagsToSnapshots = TRUE|FALSE,
ReadOnly = TRUE|FALSE
),
PreferredSubnetId = "string",
EndpointIpAddressRange = "string",
RouteTableIds = list(
"string"
),
ReadCacheConfiguration = list(
SizingMode = "NO_CACHE"|"USER_PROVISIONED"|"PROPORTIONAL_TO_THROUGHPUT_CAPACITY",
SizeGiB = 123
)
)
)
Examples¶
## Not run:
# This operation creates a new Amazon FSx for Windows File Server file
# system.
svc$create_file_system(
ClientRequestToken = "a8ca07e4-61ec-4399-99f4-19853801bcd5",
FileSystemType = "WINDOWS",
KmsKeyId = "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff",
SecurityGroupIds = list(
"sg-edcd9784"
),
StorageCapacity = 3200L,
StorageType = "HDD",
SubnetIds = list(
"subnet-1234abcd"
),
Tags = list(
list(
Key = "Name",
Value = "MyFileSystem"
)
),
WindowsConfiguration = list(
ActiveDirectoryId = "d-1234abcd12",
Aliases = list(
"accounting.corp.example.com"
),
AutomaticBackupRetentionDays = 30L,
DailyAutomaticBackupStartTime = "05:00",
ThroughputCapacity = 32L,
WeeklyMaintenanceStartTime = "1:05:00"
)
)
## End(Not run)