Struct aws_sdk_fsx::operation::create_file_system_from_backup::builders::CreateFileSystemFromBackupFluentBuilder

pub struct CreateFileSystemFromBackupFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateFileSystemFromBackup.

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS 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 file system with the specified client request token exists but 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 the 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 CreateFileSystemFromBackup 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 a success message as long as the parameters are the same.

The CreateFileSystemFromBackup 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

impl CreateFileSystemFromBackupFluentBuilder

pub fn as_input(&self) -> &CreateFileSystemFromBackupInputBuilder

Access the CreateFileSystemFromBackup as a reference.

pub async fn send( self ) -> Result<CreateFileSystemFromBackupOutput, SdkError<CreateFileSystemFromBackupError, 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.

pub fn customize( self ) -> CustomizableOperation<CreateFileSystemFromBackupOutput, CreateFileSystemFromBackupError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn backup_id(self, input: impl Into<String>) -> Self

The ID of the source backup. Specifies the backup that you are copying.

pub fn set_backup_id(self, input: Option<String>) -> Self

The ID of the source backup. Specifies the backup that you are copying.

pub fn get_backup_id(&self) -> &Option<String>

The ID of the source backup. Specifies the backup that you are copying.

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.

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.

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.

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 MULTI_AZ_1 file system 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 property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

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 MULTI_AZ_1 file system 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 property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

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 MULTI_AZ_1 file system 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 property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

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 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.

pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_security_group_ids(&self) -> &Option<Vec<String>>

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

pub fn windows_configuration( self, input: CreateFileSystemWindowsConfiguration ) -> Self

The configuration for this Microsoft Windows file system.

pub fn set_windows_configuration( self, input: Option<CreateFileSystemWindowsConfiguration> ) -> Self

The configuration for this Microsoft Windows file system.

pub fn get_windows_configuration( &self ) -> &Option<CreateFileSystemWindowsConfiguration>

The configuration for this Microsoft Windows file system.

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

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

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

pub fn storage_type(self, input: StorageType) -> Self

Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

• Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.

• Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

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 if the original SSD file system had a storage capacity of at least 2000 GiB.

pub fn set_storage_type(self, input: Option<StorageType>) -> Self

Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

• Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.

• Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

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 if the original SSD file system had a storage capacity of at least 2000 GiB.

pub fn get_storage_type(&self) -> &Option<StorageType>

Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

• Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.

• Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

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 if the original SSD file system had a storage capacity of at least 2000 GiB.

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 and PERSISTENT_2 deployment types only.

  SCRATCH_1 and SCRATCH_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.

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 and PERSISTENT_2 deployment types only.

  SCRATCH_1 and SCRATCH_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.

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 and PERSISTENT_2 deployment types only.

  SCRATCH_1 and SCRATCH_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.

pub fn file_system_type_version(self, input: impl Into<String>) -> Self

Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

pub fn set_file_system_type_version(self, input: Option<String>) -> Self

Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

pub fn get_file_system_type_version(&self) -> &Option<String>

Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

pub fn open_zfs_configuration( self, input: CreateFileSystemOpenZfsConfiguration ) -> Self

The OpenZFS configuration for the file system that's being created.

pub fn set_open_zfs_configuration( self, input: Option<CreateFileSystemOpenZfsConfiguration> ) -> Self

The OpenZFS configuration for the file system that's being created.

pub fn get_open_zfs_configuration( &self ) -> &Option<CreateFileSystemOpenZfsConfiguration>

The OpenZFS configuration for the file system that's being created.

pub fn storage_capacity(self, input: i32) -> Self

Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.

pub fn set_storage_capacity(self, input: Option<i32>) -> Self

Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.

pub fn get_storage_capacity(&self) -> &Option<i32>

Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.

Trait Implementations

impl Clone for CreateFileSystemFromBackupFluentBuilder

fn clone(&self) -> CreateFileSystemFromBackupFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFileSystemFromBackupFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.