CreateFileSystemRequest (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.CreateFileSystemRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>

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

The request object used to create a new Amazon FSx file system.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFileSystemRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFileSystemRequest.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)`
`FileSystemType`	`fileSystemType()` The type of Amazon FSx file system to create, either `WINDOWS` or `LUSTRE`.
`String`	`fileSystemTypeAsString()` The type of Amazon FSx file system to create, either `WINDOWS` or `LUSTRE`.
`<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 specifying the security groups to apply to all network interfaces created for file system access.
`static Class<? extends CreateFileSystemRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`storageCapacity()` Sets the storage capacity of the file system that you're creating.
`StorageType`	`storageType()` Sets the storage type for the file system you're creating.
`String`	`storageTypeAsString()` Sets the storage type for the file system you're creating.
`List<String>`	`subnetIds()` Specifies the IDs of the subnets that the file system will be accessible from.
`List<Tag>`	`tags()` The tags to apply to the file system being created.
`CreateFileSystemRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`CreateFileSystemWindowsConfiguration`	`windowsConfiguration()` The Microsoft Windows configuration for the file system being created.

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
  - 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.
  - fileSystemType
```
public final FileSystemType fileSystemType()
```
    The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
    
    If the service returns an enum value that is not available in the current SDK version, fileSystemType will return FileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileSystemTypeAsString().
    
    Returns:
    
    The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
    
    See Also:
    
    FileSystemType
  - fileSystemTypeAsString
```
public final String fileSystemTypeAsString()
```
    The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
    
    If the service returns an enum value that is not available in the current SDK version, fileSystemType will return FileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileSystemTypeAsString().
    
    Returns:
    
    The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
    
    See Also:
    
    FileSystemType
  - storageCapacity
```
public final Integer storageCapacity()
```
    Sets the storage capacity of the file system that you're creating.
    
    For Lustre file systems:
    - For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    - For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
    - For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
    For Windows file systems:
    - If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
    - If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
    Returns:
    Sets the storage capacity of the file system that you're creating.
    
    For Lustre file systems:
    
    For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    
    For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
    
    For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
    
    For Windows file systems:
    
    If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
    
    If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
  - storageType
```
public final StorageType storageType()
```
    Sets the storage type for the file system you're creating. Valid values are SSD and HDD .
    - Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment types.
    - Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.
    Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.
    
    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 file system you're creating. Valid values are SSD and HDD.
    
    Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment types.
    
    Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.
    
    Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.
    See Also:
    
    StorageType
  - storageTypeAsString
```
public final String storageTypeAsString()
```
    Sets the storage type for the file system you're creating. Valid values are SSD and HDD .
    - Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment types.
    - Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.
    Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.
    
    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 file system you're creating. Valid values are SSD and HDD.
    
    Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment types.
    
    Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.
    
    Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.
    See Also:
    
    StorageType
  - 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 more information, see Availability and durability: Single-AZ and Multi-AZ file systems.
    
    For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system 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 more information, see Availability and durability: Single-AZ and Multi-AZ file systems.
    
    For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system 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 specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
    
    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 specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
  - 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 apply to the file system being created. 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 apply to the file system being created. The key value of the Name tag appears in the console as the file system name.
  - 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.
  - windowsConfiguration
```
public final CreateFileSystemWindowsConfiguration windowsConfiguration()
```
    The Microsoft Windows configuration for the file system being created.
    
    Returns:
    
    The Microsoft Windows configuration for the file system being created.
  - 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.
  - toBuilder
```
public CreateFileSystemRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>
    
    Specified by:
    
    toBuilder in class FSxRequest
  - builder
```
public static CreateFileSystemRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFileSystemRequest.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 CreateFileSystemRequest

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

clientRequestToken

fileSystemType

fileSystemTypeAsString

storageCapacity

storageType

storageTypeAsString

hasSubnetIds

subnetIds

hasSecurityGroupIds

securityGroupIds

hasTags

tags

kmsKeyId

windowsConfiguration

lustreConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields