You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFileSystemFromBackupRequest as input to an Aws::Client method, you can use a vanilla 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,
  },
  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
  },
  storage_type: "SSD", # accepts SSD, HDD
}

The request object for the CreateFileSystemFromBackup operation.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.

Returns:

  • (String)

    The ID of the backup.

#client_request_tokenString

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 AWS Command Line Interface (AWS CLI) or an AWS SDK.

Returns:

  • (String)

    A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.

#lustre_configurationTypes::CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

Returns:

#security_group_idsArray<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>)

    A list of IDs for the security groups that apply to the specified network interfaces created for file system access.

#storage_typeString

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.

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.

Possible values:

  • SSD
  • HDD

Returns:

  • (String)

    Sets the storage type for the Windows file system you\'re creating from a backup.

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

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.

Returns:

  • (Array<String>)

    Specifies the IDs of the subnets that the file system will be accessible from.

#tagsArray<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:

  • (Array<Types::Tag>)

    The tags to be applied to the file system at file system creation.

#windows_configurationTypes::CreateFileSystemWindowsConfiguration

The configuration for this Microsoft Windows file system.

Returns: