Interface CreateFileSystemRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateFileSystemRequest.Builder,
,CreateFileSystemRequest> FSxRequest.Builder
,SdkBuilder<CreateFileSystemRequest.Builder,
,CreateFileSystemRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateFileSystemRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation.fileSystemType
(String fileSystemType) The type of Amazon FSx file system to create.fileSystemType
(FileSystemType fileSystemType) The type of Amazon FSx file system to create.fileSystemTypeVersion
(String fileSystemTypeVersion) (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.Sets the value of the KmsKeyId property for this object.default CreateFileSystemRequest.Builder
lustreConfiguration
(Consumer<CreateFileSystemLustreConfiguration.Builder> lustreConfiguration) Sets the value of the LustreConfiguration property for this object.lustreConfiguration
(CreateFileSystemLustreConfiguration lustreConfiguration) Sets the value of the LustreConfiguration property for this object.default CreateFileSystemRequest.Builder
ontapConfiguration
(Consumer<CreateFileSystemOntapConfiguration.Builder> ontapConfiguration) Sets the value of the OntapConfiguration property for this object.ontapConfiguration
(CreateFileSystemOntapConfiguration ontapConfiguration) Sets the value of the OntapConfiguration property for this object.default CreateFileSystemRequest.Builder
openZFSConfiguration
(Consumer<CreateFileSystemOpenZFSConfiguration.Builder> openZFSConfiguration) The OpenZFS configuration for the file system that's being created.openZFSConfiguration
(CreateFileSystemOpenZFSConfiguration openZFSConfiguration) The OpenZFS configuration for the file system that's being created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.securityGroupIds
(String... securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.securityGroupIds
(Collection<String> securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.storageCapacity
(Integer storageCapacity) Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).storageType
(String storageType) Sets the storage type for the file system that you're creating.storageType
(StorageType storageType) Sets the storage type for the file system that you're creating.Specifies the IDs of the subnets that the file system will be accessible from.subnetIds
(Collection<String> subnetIds) Specifies the IDs of the subnets that the file system will be accessible from.tags
(Collection<Tag> tags) The tags to apply to the file system that's being created.tags
(Consumer<Tag.Builder>... tags) The tags to apply to the file system that's being created.The tags to apply to the file system that's being created.default CreateFileSystemRequest.Builder
windowsConfiguration
(Consumer<CreateFileSystemWindowsConfiguration.Builder> windowsConfiguration) The Microsoft Windows configuration for the file system that's being created.windowsConfiguration
(CreateFileSystemWindowsConfiguration windowsConfiguration) The Microsoft Windows configuration for the file system that's being created.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The type of Amazon FSx file system to create. Valid values are
WINDOWS
,LUSTRE
,ONTAP
, andOPENZFS
.- Parameters:
fileSystemType
- The type of Amazon FSx file system to create. Valid values areWINDOWS
,LUSTRE
,ONTAP
, andOPENZFS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileSystemType
The type of Amazon FSx file system to create. Valid values are
WINDOWS
,LUSTRE
,ONTAP
, andOPENZFS
.- Parameters:
fileSystemType
- The type of Amazon FSx file system to create. Valid values areWINDOWS
,LUSTRE
,ONTAP
, andOPENZFS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 LustreDeploymentType
, as follows:-
For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_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 LustreDeploymentType
, as follows:-
For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_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
Sets the storage type for the file system that you're creating. Valid values are
SSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_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 areSSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_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
Sets the storage type for the file system that you're creating. Valid values are
SSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_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 areSSD
andHDD
.-
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 onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_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 theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > 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
andSINGLE_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 ONTAPMULTI_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 theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > 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
andSINGLE_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
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 theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > 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
andSINGLE_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 ONTAPMULTI_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 theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > 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
andSINGLE_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
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
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 theName
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 theName
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
This is a convenience method that creates an instance of theName
tag appears in the console as the file system name.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.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 theCreateFileSystemWindowsConfiguration.Builder
avoiding the need to create one manually viaCreateFileSystemWindowsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towindowsConfiguration(CreateFileSystemWindowsConfiguration)
.- Parameters:
windowsConfiguration
- a consumer that will call methods onCreateFileSystemWindowsConfiguration.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 theCreateFileSystemLustreConfiguration.Builder
avoiding the need to create one manually viaCreateFileSystemLustreConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolustreConfiguration(CreateFileSystemLustreConfiguration)
.- Parameters:
lustreConfiguration
- a consumer that will call methods onCreateFileSystemLustreConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ontapConfiguration
CreateFileSystemRequest.Builder ontapConfiguration(CreateFileSystemOntapConfiguration 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
default CreateFileSystemRequest.Builder ontapConfiguration(Consumer<CreateFileSystemOntapConfiguration.Builder> ontapConfiguration) Sets the value of the OntapConfiguration property for this object. This is a convenience method that creates an instance of theCreateFileSystemOntapConfiguration.Builder
avoiding the need to create one manually viaCreateFileSystemOntapConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toontapConfiguration(CreateFileSystemOntapConfiguration)
.- Parameters:
ontapConfiguration
- a consumer that will call methods onCreateFileSystemOntapConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
, and2.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
or2.15
is required when setting FSx for LustreDeploymentType
toPERSISTENT_2
.
Default value =
2.10
, except whenDeploymentType
is set toPERSISTENT_2
, then the default is2.12
.If you set
FileSystemTypeVersion
to2.10
for aPERSISTENT_2
Lustre deployment type, theCreateFileSystem
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 are2.10
,2.12
, and2.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
or2.15
is required when setting FSx for LustreDeploymentType
toPERSISTENT_2
.
Default value =
2.10
, except whenDeploymentType
is set toPERSISTENT_2
, then the default is2.12
.If you set
FileSystemTypeVersion
to2.10
for aPERSISTENT_2
Lustre deployment type, theCreateFileSystem
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 theCreateFileSystemOpenZFSConfiguration.Builder
avoiding the need to create one manually viaCreateFileSystemOpenZFSConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopenZFSConfiguration(CreateFileSystemOpenZFSConfiguration)
.- Parameters:
openZFSConfiguration
- a consumer that will call methods onCreateFileSystemOpenZFSConfiguration.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 interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateFileSystemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-