software.amazon.awssdk.services.fsx.model

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 Summary

Modifier and Type	Method and Description
CreateFileSystemRequest.Builder	clientRequestToken(String clientRequestToken) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
CreateFileSystemRequest.Builder	fileSystemType(FileSystemType fileSystemType) The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
CreateFileSystemRequest.Builder	fileSystemType(String fileSystemType) The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
CreateFileSystemRequest.Builder	kmsKeyId(String kmsKeyId) 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.
CreateFileSystemRequest.Builder	lustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration) Sets the value of the LustreConfiguration property for this object.
CreateFileSystemRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateFileSystemRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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.
CreateFileSystemRequest.Builder	securityGroupIds(String... securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
CreateFileSystemRequest.Builder	storageCapacity(Integer storageCapacity) Sets the storage capacity of the file system that you're creating.
CreateFileSystemRequest.Builder	storageType(StorageType storageType) Sets the storage type for the file system you're creating.
CreateFileSystemRequest.Builder	storageType(String storageType) Sets the storage type for the file system you're creating.
CreateFileSystemRequest.Builder	subnetIds(Collection<String> subnetIds) Specifies the IDs of the subnets that the file system will be accessible from.
CreateFileSystemRequest.Builder	subnetIds(String... subnetIds) Specifies the IDs of the subnets that the file system will be accessible from.
CreateFileSystemRequest.Builder	tags(Collection<Tag> tags) The tags to apply to the file system being created.
CreateFileSystemRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags to apply to the file system being created.
CreateFileSystemRequest.Builder	tags(Tag... tags) The tags to apply to the file system being created.
default CreateFileSystemRequest.Builder	windowsConfiguration(Consumer<CreateFileSystemWindowsConfiguration.Builder> windowsConfiguration) The Microsoft Windows configuration for the file system being created.
CreateFileSystemRequest.Builder	windowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration) The Microsoft Windows configuration for the file system being created.

Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clientRequestToken

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

Parameters:

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:

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, either WINDOWS or LUSTRE.

Parameters:

fileSystemType - The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.

Returns:

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

See Also:

FileSystemType, FileSystemType

fileSystemType

CreateFileSystemRequest.Builder fileSystemType(FileSystemType fileSystemType)

The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.

Parameters:

fileSystemType - The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.

Returns:

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

See Also:

FileSystemType, FileSystemType

storageCapacity

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

Parameters:

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:

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

Parameters:

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.

Returns:

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

See Also:

StorageType, StorageType

storageType

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

Parameters:

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.

Returns:

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

See Also:

StorageType, StorageType

subnetIds

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

Parameters:

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.

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

Parameters:

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.

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.

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.

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.

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.

Returns:

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

tags

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

Parameters:

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.

Returns:

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

tags

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

Parameters:

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.

Returns:

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

tags

CreateFileSystemRequest.Builder tags(Consumer<Tag.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

kmsKeyId

CreateFileSystemRequest.Builder kmsKeyId(String 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 being created.

Parameters:

windowsConfiguration - The Microsoft Windows configuration for the file system 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 being created.

This is a convenience 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:

windowsConfiguration(CreateFileSystemWindowsConfiguration)

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

lustreConfiguration(CreateFileSystemLustreConfiguration)

overrideConfiguration

CreateFileSystemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateFileSystemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder