#[non_exhaustive]pub struct CreateFileSystemInput {Show 13 fields
pub client_request_token: Option<String>,
pub file_system_type: Option<FileSystemType>,
pub storage_capacity: Option<i32>,
pub storage_type: Option<StorageType>,
pub subnet_ids: Option<Vec<String>>,
pub security_group_ids: Option<Vec<String>>,
pub tags: Option<Vec<Tag>>,
pub kms_key_id: Option<String>,
pub windows_configuration: Option<CreateFileSystemWindowsConfiguration>,
pub lustre_configuration: Option<CreateFileSystemLustreConfiguration>,
pub ontap_configuration: Option<CreateFileSystemOntapConfiguration>,
pub file_system_type_version: Option<String>,
pub open_zfs_configuration: Option<CreateFileSystemOpenZfsConfiguration>,
}
Expand description
The request object used to create a new Amazon FSx file system.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.client_request_token: Option<String>
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.
file_system_type: Option<FileSystemType>
The type of Amazon FSx file system to create. Valid values are WINDOWS
, LUSTRE
, ONTAP
, and OPENZFS
.
storage_capacity: Option<i32>
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 StorageType
and the Lustre DeploymentType
, as follows:
-
For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_1
deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. -
For
PERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. -
For
SCRATCH_1
deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs
property. The minimum value is calculated as 1,024 * HAPairs
and the maximum is calculated as 524,288 * HAPairs
.
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
as follows:
-
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
-
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
storage_type: Option<StorageType>
Sets the storage type for the file system that you're creating. Valid values are SSD
and HDD
.
-
Set to
SSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. -
Set to
HDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_1
Lustre file system deployment types.
Default value is SSD
. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.
subnet_ids: Option<Vec<String>>
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1
deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID
or OntapConfiguration > PreferredSubnetID
properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
security_group_ids: Option<Vec<String>>
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.
The tags to apply to the file system that's being created. The key value of the Name
tag appears in the console as the file system name.
kms_key_id: Option<String>
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
windows_configuration: Option<CreateFileSystemWindowsConfiguration>
The Microsoft Windows configuration for the file system that's being created.
lustre_configuration: Option<CreateFileSystemLustreConfiguration>
The Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
-
AutoImportPolicy
-
ExportPath
-
ImportedFileChunkSize
-
ImportPath
ontap_configuration: Option<CreateFileSystemOntapConfiguration>
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
file_system_type_version: Option<String>
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10
, 2.12
, and 2.15
:
-
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
-
2.12 and 2.15 are supported by all Lustre deployment types.
2.12
or2.15
is required when setting FSx for LustreDeploymentType
toPERSISTENT_2
.
Default value = 2.10
, except when DeploymentType
is set to PERSISTENT_2
, then the default is 2.12
.
If you set FileSystemTypeVersion
to 2.10
for a PERSISTENT_2
Lustre deployment type, the CreateFileSystem
operation fails.
open_zfs_configuration: Option<CreateFileSystemOpenZfsConfiguration>
The OpenZFS configuration for the file system that's being created.
Implementations§
source§impl CreateFileSystemInput
impl CreateFileSystemInput
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
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.
sourcepub fn file_system_type(&self) -> Option<&FileSystemType>
pub fn file_system_type(&self) -> Option<&FileSystemType>
The type of Amazon FSx file system to create. Valid values are WINDOWS
, LUSTRE
, ONTAP
, and OPENZFS
.
sourcepub fn storage_capacity(&self) -> Option<i32>
pub fn storage_capacity(&self) -> Option<i32>
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 StorageType
and the Lustre DeploymentType
, as follows:
-
For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_1
deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. -
For
PERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. -
For
SCRATCH_1
deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs
property. The minimum value is calculated as 1,024 * HAPairs
and the maximum is calculated as 524,288 * HAPairs
.
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
as follows:
-
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
-
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
sourcepub fn storage_type(&self) -> Option<&StorageType>
pub fn storage_type(&self) -> Option<&StorageType>
Sets the storage type for the file system that you're creating. Valid values are SSD
and HDD
.
-
Set to
SSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. -
Set to
HDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_1
Lustre file system deployment types.
Default value is SSD
. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.
sourcepub fn subnet_ids(&self) -> &[String]
pub fn subnet_ids(&self) -> &[String]
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1
deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID
or OntapConfiguration > PreferredSubnetID
properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subnet_ids.is_none()
.
sourcepub fn security_group_ids(&self) -> &[String]
pub fn security_group_ids(&self) -> &[String]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_group_ids.is_none()
.
The tags to apply to the file system that's being created. The key value of the Name
tag appears in the console as the file system name.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
sourcepub fn windows_configuration(
&self
) -> Option<&CreateFileSystemWindowsConfiguration>
pub fn windows_configuration( &self ) -> Option<&CreateFileSystemWindowsConfiguration>
The Microsoft Windows configuration for the file system that's being created.
sourcepub fn lustre_configuration(
&self
) -> Option<&CreateFileSystemLustreConfiguration>
pub fn lustre_configuration( &self ) -> Option<&CreateFileSystemLustreConfiguration>
The Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
-
AutoImportPolicy
-
ExportPath
-
ImportedFileChunkSize
-
ImportPath
sourcepub fn ontap_configuration(&self) -> Option<&CreateFileSystemOntapConfiguration>
pub fn ontap_configuration(&self) -> Option<&CreateFileSystemOntapConfiguration>
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
sourcepub fn file_system_type_version(&self) -> Option<&str>
pub fn file_system_type_version(&self) -> Option<&str>
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10
, 2.12
, and 2.15
:
-
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
-
2.12 and 2.15 are supported by all Lustre deployment types.
2.12
or2.15
is required when setting FSx for LustreDeploymentType
toPERSISTENT_2
.
Default value = 2.10
, except when DeploymentType
is set to PERSISTENT_2
, then the default is 2.12
.
If you set FileSystemTypeVersion
to 2.10
for a PERSISTENT_2
Lustre deployment type, the CreateFileSystem
operation fails.
sourcepub fn open_zfs_configuration(
&self
) -> Option<&CreateFileSystemOpenZfsConfiguration>
pub fn open_zfs_configuration( &self ) -> Option<&CreateFileSystemOpenZfsConfiguration>
The OpenZFS configuration for the file system that's being created.
source§impl CreateFileSystemInput
impl CreateFileSystemInput
sourcepub fn builder() -> CreateFileSystemInputBuilder
pub fn builder() -> CreateFileSystemInputBuilder
Creates a new builder-style object to manufacture CreateFileSystemInput
.
Trait Implementations§
source§impl Clone for CreateFileSystemInput
impl Clone for CreateFileSystemInput
source§fn clone(&self) -> CreateFileSystemInput
fn clone(&self) -> CreateFileSystemInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateFileSystemInput
impl Debug for CreateFileSystemInput
source§impl PartialEq for CreateFileSystemInput
impl PartialEq for CreateFileSystemInput
source§fn eq(&self, other: &CreateFileSystemInput) -> bool
fn eq(&self, other: &CreateFileSystemInput) -> bool
self
and other
values to be equal, and is used
by ==
.