class Aws::FSx::Types::CreateFileSystemFromBackupRequest

The request object for the `CreateFileSystemFromBackup` operation.

@note When making an API call, you may pass CreateFileSystemFromBackupRequest

data as a hash:

    {
      backup_id: "BackupId", # required
      client_request_token: "ClientRequestToken",
      subnet_ids: ["SubnetId"], # required
      security_group_ids: ["SecurityGroupId"],
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      windows_configuration: {
        active_directory_id: "DirectoryId",
        self_managed_active_directory_configuration: {
          domain_name: "ActiveDirectoryFullyQualifiedName", # required
          organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
          file_system_administrators_group: "FileSystemAdministratorsGroupName",
          user_name: "DirectoryUserName", # required
          password: "DirectoryPassword", # required
          dns_ips: ["IpAddress"], # required
        },
        deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
        preferred_subnet_id: "SubnetId",
        throughput_capacity: 1, # required
        weekly_maintenance_start_time: "WeeklyTime",
        daily_automatic_backup_start_time: "DailyTime",
        automatic_backup_retention_days: 1,
        copy_tags_to_backups: false,
        aliases: ["AlternateDNSName"],
        audit_log_configuration: {
          file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
          file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
          audit_log_destination: "GeneralARN",
        },
      },
      lustre_configuration: {
        weekly_maintenance_start_time: "WeeklyTime",
        import_path: "ArchivePath",
        export_path: "ArchivePath",
        imported_file_chunk_size: 1,
        deployment_type: "SCRATCH_1", # accepts SCRATCH_1, SCRATCH_2, PERSISTENT_1
        auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED
        per_unit_storage_throughput: 1,
        daily_automatic_backup_start_time: "DailyTime",
        automatic_backup_retention_days: 1,
        copy_tags_to_backups: false,
        drive_cache_type: "NONE", # accepts NONE, READ
        data_compression_type: "NONE", # accepts NONE, LZ4
      },
      storage_type: "SSD", # accepts SSD, HDD
      kms_key_id: "KmsKeyId",
    }

@!attribute [rw] backup_id

The ID of the source backup. Specifies the backup you are copying.
@return [String]

@!attribute [rw] client_request_token

A string of up to 64 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.
@return [String]

@!attribute [rw] 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.

For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` deployment types and
Lustre file systems, provide exactly one subnet ID. The file server
is launched in that subnet's Availability Zone.
@return [Array<String>]

@!attribute [rw] 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.
@return [Array<String>]

@!attribute [rw] 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.
@return [Array<Types::Tag>]

@!attribute [rw] windows_configuration

The configuration for this Microsoft Windows file system.
@return [Types::CreateFileSystemWindowsConfiguration]

@!attribute [rw] lustre_configuration

The Lustre configuration for the file system being created.
@return [Types::CreateFileSystemLustreConfiguration]

@!attribute [rw] storage_type

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

* Set to `SSD` to use solid state drive storage. Supported on all
  Windows deployment types.

* Set to `HDD` to use hard disk drive storage. Supported on
  `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment
  types.

Default value is `SSD`.

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

 </note>
@return [String]

@!attribute [rw] kms_key_id

The ID of the Key Management Service (KMS) key used to encrypt the
file system's data for Amazon FSx for Windows File Server file
systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
for Lustre `PERSISTENT_1` file systems at rest. If not specified,
the Amazon FSx managed key is used. The Amazon FSx for Lustre
`SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at
rest using Amazon FSx managed keys. For more information, see
[Encrypt][1] in the *Key Management Service API Reference*.

[1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest AWS API Documentation

Constants

SENSITIVE