CreateFileSystemFromBackupRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFileSystemFromBackupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKeyId()` Returns the value of the KmsKeyId property for this object.
`CreateFileSystemLustreConfiguration`	`lustreConfiguration()` Returns the value of the LustreConfiguration property for this object.
`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()`
`StorageType`	`storageType()` Sets the storage type for the Windows file system you're creating from a backup.
`String`	`storageTypeAsString()` Sets the storage type for the Windows file system 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 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:
    
    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.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    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.
    
    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.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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 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.
    
    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 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.
    See Also:
    
    StorageType
  - storageTypeAsString
```
public final String storageTypeAsString()
```
    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.
    
    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 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.
    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.
  - 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

Class CreateFileSystemFromBackupRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

backupId

clientRequestToken

hasSubnetIds

subnetIds

hasSecurityGroupIds

securityGroupIds

hasTags

tags

windowsConfiguration

lustreConfiguration

storageType

storageTypeAsString

kmsKeyId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields