pub struct CreateFileSystemFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateFileSystem
.
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem
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 CreateFileSystem
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, CreateFileSystem
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, CreateFileSystem
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 CreateFileSystem
call returns while the file system's lifecycle state is still CREATING
. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Implementations§
source§impl CreateFileSystemFluentBuilder
impl CreateFileSystemFluentBuilder
sourcepub fn as_input(&self) -> &CreateFileSystemInputBuilder
pub fn as_input(&self) -> &CreateFileSystemInputBuilder
Access the CreateFileSystem as a reference.
sourcepub async fn send(
self
) -> Result<CreateFileSystemOutput, SdkError<CreateFileSystemError, HttpResponse>>
pub async fn send( self ) -> Result<CreateFileSystemOutput, SdkError<CreateFileSystemError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateFileSystemOutput, CreateFileSystemError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateFileSystemOutput, CreateFileSystemError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
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 set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
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 get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &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.
sourcepub fn file_system_type(self, input: FileSystemType) -> Self
pub fn file_system_type(self, input: FileSystemType) -> Self
The type of Amazon FSx file system to create. Valid values are WINDOWS
, LUSTRE
, ONTAP
, and OPENZFS
.
sourcepub fn set_file_system_type(self, input: Option<FileSystemType>) -> Self
pub fn set_file_system_type(self, input: Option<FileSystemType>) -> Self
The type of Amazon FSx file system to create. Valid values are WINDOWS
, LUSTRE
, ONTAP
, and OPENZFS
.
sourcepub fn get_file_system_type(&self) -> &Option<FileSystemType>
pub fn get_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, input: i32) -> Self
pub fn storage_capacity(self, input: i32) -> Self
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 set_storage_capacity(self, input: Option<i32>) -> Self
pub fn set_storage_capacity(self, input: Option<i32>) -> Self
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 get_storage_capacity(&self) -> &Option<i32>
pub fn get_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, input: StorageType) -> Self
pub fn storage_type(self, input: StorageType) -> Self
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 set_storage_type(self, input: Option<StorageType>) -> Self
pub fn set_storage_type(self, input: Option<StorageType>) -> Self
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 get_storage_type(&self) -> &Option<StorageType>
pub fn get_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, input: impl Into<String>) -> Self
pub fn subnet_ids(self, input: impl Into<String>) -> Self
Appends an item to SubnetIds
.
To override the contents of this collection use set_subnet_ids
.
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.
sourcepub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_subnet_ids(&self) -> &Option<Vec<String>>
pub fn get_subnet_ids(&self) -> &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.
sourcepub fn security_group_ids(self, input: impl Into<String>) -> Self
pub fn security_group_ids(self, input: impl Into<String>) -> Self
Appends an item to SecurityGroupIds
.
To override the contents of this collection use set_security_group_ids
.
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.
sourcepub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_security_group_ids(&self) -> &Option<Vec<String>>
pub fn get_security_group_ids(&self) -> &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.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
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 set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
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 get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &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.
sourcepub fn windows_configuration(
self,
input: CreateFileSystemWindowsConfiguration
) -> Self
pub fn windows_configuration( self, input: CreateFileSystemWindowsConfiguration ) -> Self
The Microsoft Windows configuration for the file system that's being created.
sourcepub fn set_windows_configuration(
self,
input: Option<CreateFileSystemWindowsConfiguration>
) -> Self
pub fn set_windows_configuration( self, input: Option<CreateFileSystemWindowsConfiguration> ) -> Self
The Microsoft Windows configuration for the file system that's being created.
sourcepub fn get_windows_configuration(
&self
) -> &Option<CreateFileSystemWindowsConfiguration>
pub fn get_windows_configuration( &self ) -> &Option<CreateFileSystemWindowsConfiguration>
The Microsoft Windows configuration for the file system that's being created.
sourcepub fn lustre_configuration(
self,
input: CreateFileSystemLustreConfiguration
) -> Self
pub fn lustre_configuration( self, input: CreateFileSystemLustreConfiguration ) -> Self
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 set_lustre_configuration(
self,
input: Option<CreateFileSystemLustreConfiguration>
) -> Self
pub fn set_lustre_configuration( self, input: Option<CreateFileSystemLustreConfiguration> ) -> Self
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 get_lustre_configuration(
&self
) -> &Option<CreateFileSystemLustreConfiguration>
pub fn get_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,
input: CreateFileSystemOntapConfiguration
) -> Self
pub fn ontap_configuration( self, input: CreateFileSystemOntapConfiguration ) -> Self
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
sourcepub fn set_ontap_configuration(
self,
input: Option<CreateFileSystemOntapConfiguration>
) -> Self
pub fn set_ontap_configuration( self, input: Option<CreateFileSystemOntapConfiguration> ) -> Self
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
sourcepub fn get_ontap_configuration(
&self
) -> &Option<CreateFileSystemOntapConfiguration>
pub fn get_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, input: impl Into<String>) -> Self
pub fn file_system_type_version(self, input: impl Into<String>) -> Self
(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 set_file_system_type_version(self, input: Option<String>) -> Self
pub fn set_file_system_type_version(self, input: Option<String>) -> Self
(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 get_file_system_type_version(&self) -> &Option<String>
pub fn get_file_system_type_version(&self) -> &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.
sourcepub fn open_zfs_configuration(
self,
input: CreateFileSystemOpenZfsConfiguration
) -> Self
pub fn open_zfs_configuration( self, input: CreateFileSystemOpenZfsConfiguration ) -> Self
The OpenZFS configuration for the file system that's being created.
sourcepub fn set_open_zfs_configuration(
self,
input: Option<CreateFileSystemOpenZfsConfiguration>
) -> Self
pub fn set_open_zfs_configuration( self, input: Option<CreateFileSystemOpenZfsConfiguration> ) -> Self
The OpenZFS configuration for the file system that's being created.
sourcepub fn get_open_zfs_configuration(
&self
) -> &Option<CreateFileSystemOpenZfsConfiguration>
pub fn get_open_zfs_configuration( &self ) -> &Option<CreateFileSystemOpenZfsConfiguration>
The OpenZFS configuration for the file system that's being created.
Trait Implementations§
source§impl Clone for CreateFileSystemFluentBuilder
impl Clone for CreateFileSystemFluentBuilder
source§fn clone(&self) -> CreateFileSystemFluentBuilder
fn clone(&self) -> CreateFileSystemFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more