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

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

Overview

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, PERSISTENT_2
    auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED, NEW_CHANGED_DELETED
    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
    log_configuration: {
      level: "DISABLED", # required, accepts DISABLED, WARN_ONLY, ERROR_ONLY, WARN_ERROR
      destination: "GeneralARN",
    },
    root_squash_configuration: {
      root_squash: "LustreRootSquash",
      no_squash_nids: ["LustreNoSquashNid"],
    },
  },
  storage_type: "SSD", # accepts SSD, HDD
  kms_key_id: "KmsKeyId",
  file_system_type_version: "FileSystemTypeVersion",
  open_zfs_configuration: {
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    copy_tags_to_volumes: false,
    daily_automatic_backup_start_time: "DailyTime",
    deployment_type: "SINGLE_AZ_1", # required, accepts SINGLE_AZ_1
    throughput_capacity: 1, # required
    weekly_maintenance_start_time: "WeeklyTime",
    disk_iops_configuration: {
      mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
      iops: 1,
    },
    root_volume_configuration: {
      record_size_ki_b: 1,
      data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
      nfs_exports: [
        {
          client_configurations: [ # required
            {
              clients: "OpenZFSClients", # required
              options: ["OpenZFSNfsExportOption"], # required
            },
          ],
        },
      ],
      user_and_group_quotas: [
        {
          type: "USER", # required, accepts USER, GROUP
          id: 1, # required
          storage_capacity_quota_gi_b: 1, # required
        },
      ],
      copy_tags_to_snapshots: false,
      read_only: false,
    },
  },
}

The request object for the CreateFileSystemFromBackup operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

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

Returns:

  • (String)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

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


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_type_versionString

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

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.

Returns:

  • (String)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configurationTypes::CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

  • AutoImportPolicy

  • ExportPath

  • ImportedChunkSize

  • ImportPath



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configurationTypes::CreateFileSystemOpenZFSConfiguration

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



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

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


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

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.

Returns:

  • (String)


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

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

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


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

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



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end

#windows_configurationTypes::CreateFileSystemWindowsConfiguration

The configuration for this Microsoft Windows file system.



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1387

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)
  SENSITIVE = []
  include Aws::Structure
end