software.amazon.awssdk.services.fsx.model

Interface FileSystem.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FileSystem.Builder,FileSystem>, SdkBuilder<FileSystem.Builder,FileSystem>, SdkPojo

Enclosing class:

FileSystem

public static interface FileSystem.Builder
extends SdkPojo, CopyableBuilder<FileSystem.Builder,FileSystem>

Method Summary

Modifier and Type	Method and Description
FileSystem.Builder	administrativeActions(AdministrativeAction... administrativeActions) A list of administrative actions for the file system that are in process or waiting to be processed.
FileSystem.Builder	administrativeActions(Collection<AdministrativeAction> administrativeActions) A list of administrative actions for the file system that are in process or waiting to be processed.
FileSystem.Builder	administrativeActions(Consumer<AdministrativeAction.Builder>... administrativeActions) A list of administrative actions for the file system that are in process or waiting to be processed.
FileSystem.Builder	creationTime(Instant creationTime) The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystem.Builder	dnsName(String dnsName) The DNS name for the file system.
default FileSystem.Builder	failureDetails(Consumer<FileSystemFailureDetails.Builder> failureDetails) Sets the value of the FailureDetails property for this object.
FileSystem.Builder	failureDetails(FileSystemFailureDetails failureDetails) Sets the value of the FailureDetails property for this object.
FileSystem.Builder	fileSystemId(String fileSystemId) The system-generated, unique 17-digit ID of the file system.
FileSystem.Builder	fileSystemType(FileSystemType fileSystemType) The type of Amazon FSx file system, either LUSTRE or WINDOWS.
FileSystem.Builder	fileSystemType(String fileSystemType) The type of Amazon FSx file system, either LUSTRE or WINDOWS.
FileSystem.Builder	kmsKeyId(String kmsKeyId) The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest.
FileSystem.Builder	lifecycle(FileSystemLifecycle lifecycle) The lifecycle status of the file system, following are the possible values and what they mean:
FileSystem.Builder	lifecycle(String lifecycle) The lifecycle status of the file system, following are the possible values and what they mean:
default FileSystem.Builder	lustreConfiguration(Consumer<LustreFileSystemConfiguration.Builder> lustreConfiguration) Sets the value of the LustreConfiguration property for this object.
FileSystem.Builder	lustreConfiguration(LustreFileSystemConfiguration lustreConfiguration) Sets the value of the LustreConfiguration property for this object.
FileSystem.Builder	networkInterfaceIds(Collection<String> networkInterfaceIds) The IDs of the elastic network interface from which a specific file system is accessible.
FileSystem.Builder	networkInterfaceIds(String... networkInterfaceIds) The IDs of the elastic network interface from which a specific file system is accessible.
FileSystem.Builder	ownerId(String ownerId) The AWS account that created the file system.
FileSystem.Builder	resourceARN(String resourceARN) The Amazon Resource Name (ARN) for the file system resource.
FileSystem.Builder	storageCapacity(Integer storageCapacity) The storage capacity of the file system in gibibytes (GiB).
FileSystem.Builder	storageType(StorageType storageType) The storage type of the file system.
FileSystem.Builder	storageType(String storageType) The storage type of the file system.
FileSystem.Builder	subnetIds(Collection<String> subnetIds) Specifies the IDs of the subnets that the file system is accessible from.
FileSystem.Builder	subnetIds(String... subnetIds) Specifies the IDs of the subnets that the file system is accessible from.
FileSystem.Builder	tags(Collection<Tag> tags) The tags to associate with the file system.
FileSystem.Builder	tags(Consumer<Tag.Builder>... tags) The tags to associate with the file system.
FileSystem.Builder	tags(Tag... tags) The tags to associate with the file system.
FileSystem.Builder	vpcId(String vpcId) The ID of the primary VPC for the file system.
default FileSystem.Builder	windowsConfiguration(Consumer<WindowsFileSystemConfiguration.Builder> windowsConfiguration) The configuration for this Microsoft Windows file system.
FileSystem.Builder	windowsConfiguration(WindowsFileSystemConfiguration windowsConfiguration) The configuration for this Microsoft Windows file system.

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

ownerId

FileSystem.Builder ownerId(String ownerId)

The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

Parameters:

ownerId - The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

Returns:

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

creationTime

FileSystem.Builder creationTime(Instant creationTime)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Parameters:

creationTime - The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Returns:

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

fileSystemId

FileSystem.Builder fileSystemId(String fileSystemId)

The system-generated, unique 17-digit ID of the file system.

Parameters:

fileSystemId - The system-generated, unique 17-digit ID of the file system.

Returns:

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

fileSystemType

FileSystem.Builder fileSystemType(String fileSystemType)

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

Parameters:

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

Returns:

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

See Also:

FileSystemType, FileSystemType

fileSystemType

FileSystem.Builder fileSystemType(FileSystemType fileSystemType)

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

Parameters:

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

Returns:

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

See Also:

FileSystemType, FileSystemType

lifecycle

FileSystem.Builder lifecycle(String lifecycle)

The lifecycle status of the file system, following are the possible values and what they mean:

• AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

• CREATING - Amazon FSx is creating the new file system.

• DELETING - Amazon FSx is deleting an existing file system.

• FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

• MISCONFIGURED indicates that the file system is in a failed but recoverable state.

• UPDATING indicates that the file system is undergoing a customer initiated update.

Parameters:

lifecycle - The lifecycle status of the file system, following are the possible values and what they mean:

• AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

• CREATING - Amazon FSx is creating the new file system.

• DELETING - Amazon FSx is deleting an existing file system.

• FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

• MISCONFIGURED indicates that the file system is in a failed but recoverable state.

• UPDATING indicates that the file system is undergoing a customer initiated update.

Returns:

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

See Also:

FileSystemLifecycle, FileSystemLifecycle

lifecycle

FileSystem.Builder lifecycle(FileSystemLifecycle lifecycle)

The lifecycle status of the file system, following are the possible values and what they mean:

• AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

• CREATING - Amazon FSx is creating the new file system.

• DELETING - Amazon FSx is deleting an existing file system.

• FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

• MISCONFIGURED indicates that the file system is in a failed but recoverable state.

• UPDATING indicates that the file system is undergoing a customer initiated update.

Parameters:

lifecycle - The lifecycle status of the file system, following are the possible values and what they mean:

• AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

• CREATING - Amazon FSx is creating the new file system.

• DELETING - Amazon FSx is deleting an existing file system.

• FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

• MISCONFIGURED indicates that the file system is in a failed but recoverable state.

• UPDATING indicates that the file system is undergoing a customer initiated update.

Returns:

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

See Also:

FileSystemLifecycle, FileSystemLifecycle

failureDetails

FileSystem.Builder failureDetails(FileSystemFailureDetails failureDetails)

Sets the value of the FailureDetails property for this object.

Parameters:

failureDetails - The new value for the FailureDetails property for this object.

Returns:

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

failureDetails

default FileSystem.Builder failureDetails(Consumer<FileSystemFailureDetails.Builder> failureDetails)

Sets the value of the FailureDetails property for this object. This is a convenience that creates an instance of the FileSystemFailureDetails.Builder avoiding the need to create one manually via FileSystemFailureDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDetails(FileSystemFailureDetails).

Parameters:

failureDetails - a consumer that will call methods on FileSystemFailureDetails.Builder

Returns:

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

See Also:

failureDetails(FileSystemFailureDetails)

storageCapacity

FileSystem.Builder storageCapacity(Integer storageCapacity)

The storage capacity of the file system in gibibytes (GiB).

Parameters:

storageCapacity - The storage capacity of the file system in gibibytes (GiB).

Returns:

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

storageType

FileSystem.Builder storageType(String storageType)

The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

Parameters:

storageType - The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

Returns:

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

See Also:

StorageType, StorageType

storageType

FileSystem.Builder storageType(StorageType storageType)

The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

Parameters:

storageType - The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

Returns:

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

See Also:

StorageType, StorageType

vpcId

FileSystem.Builder vpcId(String vpcId)

The ID of the primary VPC for the file system.

Parameters:

vpcId - The ID of the primary VPC for the file system.

Returns:

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

subnetIds

FileSystem.Builder subnetIds(Collection<String> subnetIds)

Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.

Returns:

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

subnetIds

FileSystem.Builder subnetIds(String... subnetIds)

Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.

Returns:

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

networkInterfaceIds

FileSystem.Builder networkInterfaceIds(Collection<String> networkInterfaceIds)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

Parameters:

networkInterfaceIds - The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

Returns:

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

networkInterfaceIds

FileSystem.Builder networkInterfaceIds(String... networkInterfaceIds)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

Parameters:

networkInterfaceIds - The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

Returns:

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

dnsName

FileSystem.Builder dnsName(String dnsName)

The DNS name for the file system.

Parameters:

dnsName - The DNS name for the file system.

Returns:

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

kmsKeyId

FileSystem.Builder kmsKeyId(String kmsKeyId)

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.

Parameters:

kmsKeyId - The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.

Returns:

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

resourceARN

FileSystem.Builder resourceARN(String resourceARN)

The Amazon Resource Name (ARN) for the file system resource.

Parameters:

resourceARN - The Amazon Resource Name (ARN) for the file system resource.

Returns:

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

tags

FileSystem.Builder tags(Collection<Tag> tags)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Parameters:

tags - The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Returns:

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

tags

FileSystem.Builder tags(Tag... tags)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Parameters:

tags - The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Returns:

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

tags

FileSystem.Builder tags(Consumer<Tag.Builder>... tags)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

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)

windowsConfiguration

FileSystem.Builder windowsConfiguration(WindowsFileSystemConfiguration windowsConfiguration)

The configuration for this Microsoft Windows file system.

Parameters:

windowsConfiguration - The configuration for this Microsoft Windows file system.

Returns:

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

windowsConfiguration

default FileSystem.Builder windowsConfiguration(Consumer<WindowsFileSystemConfiguration.Builder> windowsConfiguration)

The configuration for this Microsoft Windows file system.

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

Parameters:

windowsConfiguration - a consumer that will call methods on WindowsFileSystemConfiguration.Builder

Returns:

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

See Also:

windowsConfiguration(WindowsFileSystemConfiguration)

lustreConfiguration

FileSystem.Builder lustreConfiguration(LustreFileSystemConfiguration 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 FileSystem.Builder lustreConfiguration(Consumer<LustreFileSystemConfiguration.Builder> lustreConfiguration)

Sets the value of the LustreConfiguration property for this object. This is a convenience that creates an instance of the LustreFileSystemConfiguration.Builder avoiding the need to create one manually via LustreFileSystemConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lustreConfiguration(LustreFileSystemConfiguration).

Parameters:

lustreConfiguration - a consumer that will call methods on LustreFileSystemConfiguration.Builder

Returns:

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

See Also:

lustreConfiguration(LustreFileSystemConfiguration)

administrativeActions

FileSystem.Builder administrativeActions(Collection<AdministrativeAction> administrativeActions)

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

Parameters:

administrativeActions - A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

Returns:

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

administrativeActions

FileSystem.Builder administrativeActions(AdministrativeAction... administrativeActions)

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

Parameters:

administrativeActions - A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

Returns:

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

administrativeActions

FileSystem.Builder administrativeActions(Consumer<AdministrativeAction.Builder>... administrativeActions)

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

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 #administrativeActions(List).

Parameters:

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

#administrativeActions(List)