Interface CreateFileSystemRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>, FSxRequest.Builder, SdkBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFileSystemRequest

public static interface CreateFileSystemRequest.Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>
  • Method Details

    • clientRequestToken

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • fileSystemType

      CreateFileSystemRequest.Builder fileSystemType(String fileSystemType)

      The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.

      Parameters:
      fileSystemType - The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • fileSystemType

      CreateFileSystemRequest.Builder fileSystemType(FileSystemType fileSystemType)

      The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.

      Parameters:
      fileSystemType - The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • storageCapacity

      CreateFileSystemRequest.Builder storageCapacity(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 depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

      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).

      Parameters:
      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 depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

      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:
      Returns a reference to this object so that method calls can be chained together.
    • storageType

      CreateFileSystemRequest.Builder storageType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • storageType

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

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • subnetIds

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

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • securityGroupIds

      CreateFileSystemRequest.Builder securityGroupIds(Collection<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.

      You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

      Parameters:
      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.

      You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • securityGroupIds

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

      You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

      Parameters:
      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.

      You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • kmsKeyId

      Sets the value of the KmsKeyId property for this object.
      Parameters:
      kmsKeyId - The new value for the KmsKeyId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • windowsConfiguration

      CreateFileSystemRequest.Builder windowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration)

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

      Parameters:
      windowsConfiguration - The Microsoft Windows configuration for the file system that's being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • windowsConfiguration

      default CreateFileSystemRequest.Builder windowsConfiguration(Consumer<CreateFileSystemWindowsConfiguration.Builder> windowsConfiguration)

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

      This is a convenience method that creates an instance of the CreateFileSystemWindowsConfiguration.Builder avoiding the need to create one manually via CreateFileSystemWindowsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to windowsConfiguration(CreateFileSystemWindowsConfiguration).

      Parameters:
      windowsConfiguration - a consumer that will call methods on CreateFileSystemWindowsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • lustreConfiguration

      CreateFileSystemRequest.Builder lustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration)
      Sets the value of the LustreConfiguration property for this object.
      Parameters:
      lustreConfiguration - The new value for the LustreConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lustreConfiguration

      default CreateFileSystemRequest.Builder lustreConfiguration(Consumer<CreateFileSystemLustreConfiguration.Builder> lustreConfiguration)
      Sets the value of the LustreConfiguration property for this object. This is a convenience method that creates an instance of the CreateFileSystemLustreConfiguration.Builder avoiding the need to create one manually via CreateFileSystemLustreConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lustreConfiguration(CreateFileSystemLustreConfiguration).

      Parameters:
      lustreConfiguration - a consumer that will call methods on CreateFileSystemLustreConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • ontapConfiguration

      Sets the value of the OntapConfiguration property for this object.
      Parameters:
      ontapConfiguration - The new value for the OntapConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • ontapConfiguration

      Sets the value of the OntapConfiguration property for this object. This is a convenience method that creates an instance of the CreateFileSystemOntapConfiguration.Builder avoiding the need to create one manually via CreateFileSystemOntapConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ontapConfiguration(CreateFileSystemOntapConfiguration).

      Parameters:
      ontapConfiguration - a consumer that will call methods on CreateFileSystemOntapConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • fileSystemTypeVersion

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • openZFSConfiguration

      CreateFileSystemRequest.Builder openZFSConfiguration(CreateFileSystemOpenZFSConfiguration openZFSConfiguration)

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

      Parameters:
      openZFSConfiguration - The OpenZFS configuration for the file system that's being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • openZFSConfiguration

      default CreateFileSystemRequest.Builder openZFSConfiguration(Consumer<CreateFileSystemOpenZFSConfiguration.Builder> openZFSConfiguration)

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

      This is a convenience method that creates an instance of the CreateFileSystemOpenZFSConfiguration.Builder avoiding the need to create one manually via CreateFileSystemOpenZFSConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openZFSConfiguration(CreateFileSystemOpenZFSConfiguration).

      Parameters:
      openZFSConfiguration - a consumer that will call methods on CreateFileSystemOpenZFSConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateFileSystemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.