Class CreateFileSystemFromBackupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFileSystemFromBackupRequest.Builder,
CreateFileSystemFromBackupRequest>
The request object for the CreateFileSystemFromBackup
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
backupId()
Returns the value of the BackupId property for this object.builder()
final String
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
Returns the value of the KmsKeyId property for this object.Returns the value of the LustreConfiguration property for this object.The OpenZFS configuration for the file system that's being created.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> final Integer
Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB).final StorageType
Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup.final String
Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup.Specifies the IDs of the subnets that the file system will be accessible from.tags()
The tags to be applied to the file system at file system creation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The configuration for this Microsoft Windows file system.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
backupId
Returns the value of the BackupId property for this object.- Returns:
- The value of the BackupId property for this object.
-
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 theisEmpty()
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
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 theWindowsConfiguration > PreferredSubnetID
property.Windows
SINGLE_AZ_1
andSINGLE_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 theWindowsConfiguration > PreferredSubnetID
property.Windows
SINGLE_AZ_1
andSINGLE_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 theisEmpty()
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
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 theisEmpty()
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
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
The configuration for this Microsoft Windows file system.
- Returns:
- The configuration for this Microsoft Windows file system.
-
lustreConfiguration
Returns the value of the LustreConfiguration property for this object.- Returns:
- The value of the LustreConfiguration property for this object.
-
storageType
Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are
SSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_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 returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid
values are
SSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_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:
-
-
storageTypeAsString
Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are
SSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_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 returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid
values are
SSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_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:
-
-
kmsKeyId
Returns the value of the KmsKeyId property for this object.- Returns:
- The value of the KmsKeyId property for this object.
-
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
, and2.15
.You don't need to specify
FileSystemTypeVersion
because it will be applied using the backup'sFileSystemTypeVersion
setting. If you choose to specifyFileSystemTypeVersion
when creating from backup, the value must match the backup'sFileSystemTypeVersion
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
, and2.15
.You don't need to specify
FileSystemTypeVersion
because it will be applied using the backup'sFileSystemTypeVersion
setting. If you choose to specifyFileSystemTypeVersion
when creating from backup, the value must match the backup'sFileSystemTypeVersion
setting.
-
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
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'sStorageCapacity
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:
- 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'sStorageCapacity
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateFileSystemFromBackupRequest.Builder,
CreateFileSystemFromBackupRequest> - Specified by:
toBuilder
in classFSxRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-