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 63 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.
`String`	`fileSystemTypeAsString()` The type of Amazon FSx file system to create.
`String`	`fileSystemTypeVersion()` (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
`<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.
`CreateFileSystemOntapConfiguration`	`ontapConfiguration()` Returns the value of the OntapConfiguration 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 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, in gibibytes (GiB).
`StorageType`	`storageType()` Sets the storage type for the file system that you're creating.
`String`	`storageTypeAsString()` Sets the storage type for the file system that 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 that's being created.
`CreateFileSystemRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`CreateFileSystemWindowsConfiguration`	`windowsConfiguration()` The Microsoft Windows configuration for the file system that's 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 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.
  - fileSystemType
```
public final FileSystemType fileSystemType()
```
    The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
    
    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. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
    
    See Also:
    
    FileSystemType
  - fileSystemTypeAsString
```
public final String fileSystemTypeAsString()
```
    The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
    
    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. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
    
    See Also:
    
    FileSystemType
  - storageCapacity
```
public final Integer storageCapacity()
```
    Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
    
    FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:
    - For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    - For PERSISTENT_1 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.
    FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
    
    FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
    
    FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:
    - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
    - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
    Returns:
    Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
    
    FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:
    
    For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    
    For PERSISTENT_1 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.
    
    FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
    
    FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
    
    FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:
    
    For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
    
    For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
  - storageType
```
public final StorageType storageType()
```
    Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.
    - Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS 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_1 Lustre file system deployment types.
    Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the 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 that you're creating. Valid values are SSD and HDD.
    
    Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS 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_1 Lustre file system deployment types.
    
    Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.
    See Also:
    
    StorageType
  - storageTypeAsString
```
public final String storageTypeAsString()
```
    Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.
    - Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS 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_1 Lustre file system deployment types.
    Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the 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 that you're creating. Valid values are SSD and HDD.
    
    Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS 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_1 Lustre file system deployment types.
    
    Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.
    See Also:
    
    StorageType
  - 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 and ONTAP MULTI_AZ_1 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 or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
    
    For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, 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 and ONTAP MULTI_AZ_1 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 or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
    
    For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, 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 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.
    
    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 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()
```
    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 apply to the file system that's 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.
    
    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 apply to the file system that's 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 that's being created.
    
    Returns:
    
    The Microsoft Windows configuration for the file system that's 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.
  - ontapConfiguration
```
public final CreateFileSystemOntapConfiguration ontapConfiguration()
```
    Returns the value of the OntapConfiguration property for this object.
    
    Returns:
    
    The value of the OntapConfiguration property for this object.
  - fileSystemTypeVersion
```
public final String fileSystemTypeVersion()
```
    (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:
    - 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
    - 2.12 and 2.15 are supported by all Lustre deployment types. 2.12 or 2.15 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.
    Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.
    
    If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.
    Returns:
    (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:
    
    2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
    
    2.12 and 2.15 are supported by all Lustre deployment types. 2.12 or 2.15 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.
    
    Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.
    
    If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.
  - 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.
  - 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

ontapConfiguration

fileSystemTypeVersion

openZFSConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields