Struct aws_sdk_fsx::operation::create_file_system_from_backup::CreateFileSystemFromBackupInput

#[non_exhaustive]
pub struct CreateFileSystemFromBackupInput {
    pub backup_id: Option<String>,
    pub client_request_token: Option<String>,
    pub subnet_ids: Option<Vec<String>>,
    pub security_group_ids: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
    pub windows_configuration: Option<CreateFileSystemWindowsConfiguration>,
    pub lustre_configuration: Option<CreateFileSystemLustreConfiguration>,
    pub storage_type: Option<StorageType>,
    pub kms_key_id: Option<String>,
    pub file_system_type_version: Option<String>,
    pub open_zfs_configuration: Option<CreateFileSystemOpenZfsConfiguration>,
    pub storage_capacity: Option<i32>,
}

The request object for the CreateFileSystemFromBackup operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

backup_id: Option<String>

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

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.

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

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

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

windows_configuration: Option<CreateFileSystemWindowsConfiguration>

The configuration for this Microsoft Windows file system.

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

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

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

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

open_zfs_configuration: Option<CreateFileSystemOpenZfsConfiguration>

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

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

Implementations

impl CreateFileSystemFromBackupInput

pub fn backup_id(&self) -> Option<&str>

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

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.

pub fn subnet_ids(&self) -> &[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.

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

pub fn security_group_ids(&self) -> &[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.

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

pub fn tags(&self) -> &[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.

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

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

The configuration for this Microsoft Windows file system.

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

pub fn 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) -> 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 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) -> Option<&str>

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 ) -> Option<&CreateFileSystemOpenZfsConfiguration>

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

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

impl CreateFileSystemFromBackupInput

pub fn builder() -> CreateFileSystemFromBackupInputBuilder

Creates a new builder-style object to manufacture CreateFileSystemFromBackupInput.

Trait Implementations

impl Clone for CreateFileSystemFromBackupInput

fn clone(&self) -> CreateFileSystemFromBackupInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateFileSystemFromBackupInput

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

Formats the value using the given formatter.

impl PartialEq for CreateFileSystemFromBackupInput

fn eq(&self, other: &CreateFileSystemFromBackupInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateFileSystemFromBackupInput