software.amazon.awssdk.services.fsx.model

Class CreateFileSystemFromBackupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.fsx.model.FSxRequest

software.amazon.awssdk.services.fsx.model.CreateFileSystemFromBackupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFileSystemFromBackupRequest.Builder,CreateFileSystemFromBackupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFileSystemFromBackupRequest
extends FSxRequest
implements ToCopyableBuilder<CreateFileSystemFromBackupRequest.Builder,CreateFileSystemFromBackupRequest>

The request object for the CreateFileSystemFromBackup operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFileSystemFromBackupRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	backupId() Returns the value of the BackupId property for this object.
static CreateFileSystemFromBackupRequest.Builder	builder()
String	clientRequestToken() A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemTypeVersion() Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyId() Returns the value of the KmsKeyId property for this object.
CreateFileSystemLustreConfiguration	lustreConfiguration() Returns the value of the LustreConfiguration property for this object.
CreateFileSystemOpenZFSConfiguration	openZFSConfiguration() The OpenZFS configuration for the file system that's being created.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() A list of IDs for the security groups that apply to the specified network interfaces created for file system access.
static Class<? extends CreateFileSystemFromBackupRequest.Builder>	serializableBuilderClass()
Integer	storageCapacity() Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB).
StorageType	storageType() Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup.
String	storageTypeAsString() Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup.
List<String>	subnetIds() Specifies the IDs of the subnets that the file system will be accessible from.
List<Tag>	tags() The tags to be applied to the file system at file system creation.
CreateFileSystemFromBackupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
CreateFileSystemWindowsConfiguration	windowsConfiguration() The configuration for this Microsoft Windows file system.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

backupId

public final String backupId()

Returns the value of the BackupId property for this object.

Returns:

The value of the BackupId property for this object.

clientRequestToken

public final 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.

Returns:

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.

hasSubnetIds

public final boolean hasSubnetIds()

For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

subnetIds

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

Returns:

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.

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

securityGroupIds

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

windowsConfiguration

public final CreateFileSystemWindowsConfiguration windowsConfiguration()

The configuration for this Microsoft Windows file system.

Returns:

The configuration for this Microsoft Windows file system.

lustreConfiguration

public final CreateFileSystemLustreConfiguration lustreConfiguration()

Returns the value of the LustreConfiguration property for this object.

Returns:

The value of the LustreConfiguration property for this object.

storageType

public final 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.

If the service returns an enum value that is not available in the current SDK version, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

Returns:

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.

See Also:

StorageType

storageTypeAsString

public final String storageTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

Returns:

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.

See Also:

StorageType

kmsKeyId

public final String kmsKeyId()

Returns the value of the KmsKeyId property for this object.

Returns:

The value of the KmsKeyId property for this object.

fileSystemTypeVersion

public final 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.

Returns:

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.

openZFSConfiguration

public final CreateFileSystemOpenZFSConfiguration openZFSConfiguration()

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

Returns:

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

storageCapacity

public final 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 a 400 Bad Request.

Returns:

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 a 400 Bad Request.

toBuilder

public CreateFileSystemFromBackupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFileSystemFromBackupRequest.Builder,CreateFileSystemFromBackupRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static CreateFileSystemFromBackupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFileSystemFromBackupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo