Package software.amazon.awssdk.services.fsx.model

Interface CreateFileSystemFromBackupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFileSystemFromBackupRequest.Builder,CreateFileSystemFromBackupRequest>, FSxRequest.Builder, SdkBuilder<CreateFileSystemFromBackupRequest.Builder,CreateFileSystemFromBackupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFileSystemFromBackupRequest
public static interface CreateFileSystemFromBackupRequest.Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder<CreateFileSystemFromBackupRequest.Builder,CreateFileSystemFromBackupRequest>

  • Method Details

    • backupId

      CreateFileSystemFromBackupRequest.Builder backupId(String backupId)
      Sets the value of the BackupId property for this object.
      Parameters:
      backupId - The new value for the BackupId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      CreateFileSystemFromBackupRequest.Builder clientRequestToken(String clientRequestToken)

      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.

      Parameters:
      clientRequestToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateFileSystemFromBackupRequest.Builder subnetIds(Collection<String> subnetIds)

      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.

      Parameters:
      subnetIds - 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:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateFileSystemFromBackupRequest.Builder subnetIds(String... subnetIds)

      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.

      Parameters:
      subnetIds - 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:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroupIds

      CreateFileSystemFromBackupRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

      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.

      Parameters:
      securityGroupIds - 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:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroupIds

      CreateFileSystemFromBackupRequest.Builder securityGroupIds(String... securityGroupIds)

      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.

      Parameters:
      securityGroupIds - 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFileSystemFromBackupRequest.Builder tags(Collection<Tag> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFileSystemFromBackupRequest.Builder tags(Tag... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFileSystemFromBackupRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • windowsConfiguration

      CreateFileSystemFromBackupRequest.Builder windowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration)

      The configuration for this Microsoft Windows file system.

      Parameters:
      windowsConfiguration - The configuration for this Microsoft Windows file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • windowsConfiguration

      default CreateFileSystemFromBackupRequest.Builder windowsConfiguration(Consumer<CreateFileSystemWindowsConfiguration.Builder> windowsConfiguration)

      The configuration for this Microsoft Windows file system.

      This is a convenience method that creates an instance of the CreateFileSystemWindowsConfiguration.Builder avoiding the need to create one manually via CreateFileSystemWindowsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to windowsConfiguration(CreateFileSystemWindowsConfiguration).

      Parameters:
      windowsConfiguration - a consumer that will call methods on CreateFileSystemWindowsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lustreConfiguration

      CreateFileSystemFromBackupRequest.Builder lustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration)
      Sets the value of the LustreConfiguration property for this object.
      Parameters:
      lustreConfiguration - The new value for the LustreConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lustreConfiguration

      default CreateFileSystemFromBackupRequest.Builder lustreConfiguration(Consumer<CreateFileSystemLustreConfiguration.Builder> lustreConfiguration)
      Sets the value of the LustreConfiguration property for this object. This is a convenience method that creates an instance of the CreateFileSystemLustreConfiguration.Builder avoiding the need to create one manually via CreateFileSystemLustreConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lustreConfiguration(CreateFileSystemLustreConfiguration).

      Parameters:
      lustreConfiguration - a consumer that will call methods on CreateFileSystemLustreConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      CreateFileSystemFromBackupRequest.Builder storageType(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      CreateFileSystemFromBackupRequest.Builder storageType(StorageType 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      CreateFileSystemFromBackupRequest.Builder kmsKeyId(String kmsKeyId)
      Sets the value of the KmsKeyId property for this object.
      Parameters:
      kmsKeyId - The new value for the KmsKeyId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemTypeVersion

      CreateFileSystemFromBackupRequest.Builder fileSystemTypeVersion(String fileSystemTypeVersion)

      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.

      Parameters:
      fileSystemTypeVersion - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openZFSConfiguration

      CreateFileSystemFromBackupRequest.Builder openZFSConfiguration(CreateFileSystemOpenZFSConfiguration openZFSConfiguration)

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

      Parameters:
      openZFSConfiguration - The OpenZFS configuration for the file system that's being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openZFSConfiguration

      default CreateFileSystemFromBackupRequest.Builder openZFSConfiguration(Consumer<CreateFileSystemOpenZFSConfiguration.Builder> openZFSConfiguration)

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

      This is a convenience method that creates an instance of the CreateFileSystemOpenZFSConfiguration.Builder avoiding the need to create one manually via CreateFileSystemOpenZFSConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openZFSConfiguration(CreateFileSystemOpenZFSConfiguration).

      Parameters:
      openZFSConfiguration - a consumer that will call methods on CreateFileSystemOpenZFSConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageCapacity

      CreateFileSystemFromBackupRequest.Builder storageCapacity(Integer storageCapacity)

      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.

      Parameters:
      storageCapacity - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateFileSystemFromBackupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateFileSystemFromBackupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.