Class: Aws::FSx::Types::CreateFileSystemFromBackupRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

The request object for the CreateFileSystemFromBackup operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_id ⇒ String

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

Returns:

  • (String) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_type_version ⇒ 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 can enter a Lustre version that is newer than the backup's FileSystemTypeVersion setting. If you don't enter a newer Lustre version, it defaults to the backup's setting.

Returns:

  • (String) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ 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.

Returns:

  • (String) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configuration ⇒ Types::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

Returns:



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

Sets the network type for the Amazon FSx for OpenZFS file system that you're creating from a backup.

Returns:

  • (String) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configuration ⇒ Types::CreateFileSystemOpenZFSConfiguration

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

Returns:



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<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.

Returns:

  • (Array<String>) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity ⇒ Integer

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 an HTTP status code 400 Bad Request.

Returns:

  • (Integer) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

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

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

  • Set to INTELLIGENT_TIERING to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent_2 deployment type.

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.

Returns:

  • (String) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<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.

Returns:

  • (Array<String>) 


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::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.

Returns:



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#windows_configuration ⇒ Types::CreateFileSystemWindowsConfiguration

The configuration for this Microsoft Windows file system.

Returns:



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1845

class CreateFileSystemFromBackupRequest < Struct.new(
  :backup_id,
  :client_request_token,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :storage_type,
  :kms_key_id,
  :file_system_type_version,
  :open_zfs_configuration,
  :storage_capacity,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end