Interface FileSystem.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<FileSystem.Builder,
,FileSystem> SdkBuilder<FileSystem.Builder,
,FileSystem> SdkPojo
- Enclosing class:
FileSystem
-
Method Summary
Modifier and TypeMethodDescriptionadministrativeActions
(Collection<AdministrativeAction> administrativeActions) A list of administrative actions for the file system that are in process or waiting to be processed.administrativeActions
(Consumer<AdministrativeAction.Builder>... administrativeActions) A list of administrative actions for the file system that are in process or waiting to be processed.administrativeActions
(AdministrativeAction... administrativeActions) A list of administrative actions for the file system that are in process or waiting to be processed.creationTime
(Instant creationTime) The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.The Domain Name System (DNS) name for the file system.default FileSystem.Builder
failureDetails
(Consumer<FileSystemFailureDetails.Builder> failureDetails) Sets the value of the FailureDetails property for this object.failureDetails
(FileSystemFailureDetails failureDetails) Sets the value of the FailureDetails property for this object.fileSystemId
(String fileSystemId) The system-generated, unique 17-digit ID of the file system.fileSystemType
(String fileSystemType) The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.fileSystemType
(FileSystemType fileSystemType) The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.fileSystemTypeVersion
(String fileSystemTypeVersion) The Lustre version of the Amazon FSx for Lustre file system, which can be2.10
,2.12
, or2.15
.The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data.The lifecycle status of the file system.lifecycle
(FileSystemLifecycle lifecycle) The lifecycle status of the file system.default FileSystem.Builder
lustreConfiguration
(Consumer<LustreFileSystemConfiguration.Builder> lustreConfiguration) Sets the value of the LustreConfiguration property for this object.lustreConfiguration
(LustreFileSystemConfiguration lustreConfiguration) Sets the value of the LustreConfiguration property for this object.networkInterfaceIds
(String... networkInterfaceIds) The IDs of the elastic network interfaces from which a specific file system is accessible.networkInterfaceIds
(Collection<String> networkInterfaceIds) The IDs of the elastic network interfaces from which a specific file system is accessible.default FileSystem.Builder
ontapConfiguration
(Consumer<OntapFileSystemConfiguration.Builder> ontapConfiguration) The configuration for this Amazon FSx for NetApp ONTAP file system.ontapConfiguration
(OntapFileSystemConfiguration ontapConfiguration) The configuration for this Amazon FSx for NetApp ONTAP file system.default FileSystem.Builder
openZFSConfiguration
(Consumer<OpenZFSFileSystemConfiguration.Builder> openZFSConfiguration) The configuration for this Amazon FSx for OpenZFS file system.openZFSConfiguration
(OpenZFSFileSystemConfiguration openZFSConfiguration) The configuration for this Amazon FSx for OpenZFS file system.The Amazon Web Services account that created the file system.resourceARN
(String resourceARN) The Amazon Resource Name (ARN) of the file system resource.storageCapacity
(Integer storageCapacity) The storage capacity of the file system in gibibytes (GiB).storageType
(String storageType) The type of storage the file system is using.storageType
(StorageType storageType) The type of storage the file system is using.Specifies the IDs of the subnets that the file system is accessible from.subnetIds
(Collection<String> subnetIds) Specifies the IDs of the subnets that the file system is accessible from.tags
(Collection<Tag> tags) The tags to associate with the file system.tags
(Consumer<Tag.Builder>... tags) The tags to associate with the file system.The tags to associate with the file system.The ID of the primary virtual private cloud (VPC) for the file system.default FileSystem.Builder
windowsConfiguration
(Consumer<WindowsFileSystemConfiguration.Builder> windowsConfiguration) The configuration for this Amazon FSx for Windows File Server file system.windowsConfiguration
(WindowsFileSystemConfiguration windowsConfiguration) The configuration for this Amazon FSx for Windows File Server file system.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
ownerId
The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.
- Parameters:
ownerId
- The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services 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
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
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
The type of Amazon FSx file system, which can be
LUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.- Parameters:
fileSystemType
- The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.- 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, which can be
LUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.- Parameters:
fileSystemType
- The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lifecycle
The lifecycle status of the file system. The 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
- The file system is in a failed but recoverable state. -
MISCONFIGURED_UNAVAILABLE
- (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. -
UPDATING
- The file system is undergoing a customer-initiated update.
- Parameters:
lifecycle
- The lifecycle status of the file system. The 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
- The file system is in a failed but recoverable state. -
MISCONFIGURED_UNAVAILABLE
- (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. -
UPDATING
- 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:
-
-
lifecycle
The lifecycle status of the file system. The 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
- The file system is in a failed but recoverable state. -
MISCONFIGURED_UNAVAILABLE
- (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. -
UPDATING
- The file system is undergoing a customer-initiated update.
- Parameters:
lifecycle
- The lifecycle status of the file system. The 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
- The file system is in a failed but recoverable state. -
MISCONFIGURED_UNAVAILABLE
- (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. -
UPDATING
- 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:
-
-
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 method that creates an instance of theFileSystemFailureDetails.Builder
avoiding the need to create one manually viaFileSystemFailureDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofailureDetails(FileSystemFailureDetails)
.- Parameters:
failureDetails
- a consumer that will call methods onFileSystemFailureDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
storageCapacity
The storage capacity of the file system in gibibytes (GiB).
Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of
StorageCapacity
is outside of the minimum or maximum values.- Parameters:
storageCapacity
- The storage capacity of the file system in gibibytes (GiB).Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of
StorageCapacity
is outside of the minimum or maximum values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
The type of storage the file system is using. If set to
SSD
, the file system uses solid state drive storage. If set toHDD
, the file system uses hard disk drive storage.- Parameters:
storageType
- The type of storage the file system is using. If set toSSD
, the file system uses solid state drive storage. If set toHDD
, 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
The type of storage the file system is using. If set to
SSD
, the file system uses solid state drive storage. If set toHDD
, the file system uses hard disk drive storage.- Parameters:
storageType
- The type of storage the file system is using. If set toSSD
, the file system uses solid state drive storage. If set toHDD
, 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:
-
vpcId
The ID of the primary virtual private cloud (VPC) for the file system.
- Parameters:
vpcId
- The ID of the primary virtual private cloud (VPC) for the file system.- 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 is accessible from. For the Amazon FSx Windows and ONTAP
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 thePreferredSubnetID
property. All other file systems have only one subnet ID.For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For
MULTI_AZ_1
Windows and ONTAP file systems, the file system endpoint is available in thePreferredSubnetID
.- Parameters:
subnetIds
- Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAPMULTI_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 thePreferredSubnetID
property. All other file systems have only one subnet ID.For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For
MULTI_AZ_1
Windows and ONTAP file systems, the file system endpoint is available in thePreferredSubnetID
.- 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 is accessible from. For the Amazon FSx Windows and ONTAP
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 thePreferredSubnetID
property. All other file systems have only one subnet ID.For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For
MULTI_AZ_1
Windows and ONTAP file systems, the file system endpoint is available in thePreferredSubnetID
.- Parameters:
subnetIds
- Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAPMULTI_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 thePreferredSubnetID
property. All other file systems have only one subnet ID.For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For
MULTI_AZ_1
Windows and ONTAP file systems, the file system endpoint is available in thePreferredSubnetID
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkInterfaceIds
The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (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 interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (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
The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (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 interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (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
The Domain Name System (DNS) name for the file system.
- Parameters:
dnsName
- The Domain Name System (DNS) name for the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
- Parameters:
kmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resourceARN
The Amazon Resource Name (ARN) of the file system resource.
- Parameters:
resourceARN
- The Amazon Resource Name (ARN) of the file system resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.
- Parameters:
tags
- The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.
- Parameters:
tags
- The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.
This is a convenience method that creates an instance of theTag.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:
-
windowsConfiguration
The configuration for this Amazon FSx for Windows File Server file system.
- Parameters:
windowsConfiguration
- The configuration for this Amazon FSx for Windows File Server 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 Amazon FSx for Windows File Server file system.
This is a convenience method that creates an instance of theWindowsFileSystemConfiguration.Builder
avoiding the need to create one manually viaWindowsFileSystemConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towindowsConfiguration(WindowsFileSystemConfiguration)
.- Parameters:
windowsConfiguration
- a consumer that will call methods onWindowsFileSystemConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 method that creates an instance of theLustreFileSystemConfiguration.Builder
avoiding the need to create one manually viaLustreFileSystemConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolustreConfiguration(LustreFileSystemConfiguration)
.- Parameters:
lustreConfiguration
- a consumer that will call methods onLustreFileSystemConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 Amazon FSx system that you have initiated using the
UpdateFileSystem
operation.- 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 Amazon FSx system that you have initiated using theUpdateFileSystem
operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Amazon FSx system that you have initiated using the
UpdateFileSystem
operation.- 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 Amazon FSx system that you have initiated using theUpdateFileSystem
operation.- 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 Amazon FSx system that you have initiated using the
This is a convenience method that creates an instance of theUpdateFileSystem
operation.AdministrativeAction.Builder
avoiding the need to create one manually viaAdministrativeAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadministrativeActions(List<AdministrativeAction>)
.- Parameters:
administrativeActions
- a consumer that will call methods onAdministrativeAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ontapConfiguration
The configuration for this Amazon FSx for NetApp ONTAP file system.
- Parameters:
ontapConfiguration
- The configuration for this Amazon FSx for NetApp ONTAP file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ontapConfiguration
default FileSystem.Builder ontapConfiguration(Consumer<OntapFileSystemConfiguration.Builder> ontapConfiguration) The configuration for this Amazon FSx for NetApp ONTAP file system.
This is a convenience method that creates an instance of theOntapFileSystemConfiguration.Builder
avoiding the need to create one manually viaOntapFileSystemConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toontapConfiguration(OntapFileSystemConfiguration)
.- Parameters:
ontapConfiguration
- a consumer that will call methods onOntapFileSystemConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileSystemTypeVersion
The Lustre version of the Amazon FSx for Lustre file system, which can be
2.10
,2.12
, or2.15
.- Parameters:
fileSystemTypeVersion
- The Lustre version of the Amazon FSx for Lustre file system, which can be2.10
,2.12
, or2.15
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openZFSConfiguration
The configuration for this Amazon FSx for OpenZFS file system.
- Parameters:
openZFSConfiguration
- The configuration for this Amazon FSx for OpenZFS file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openZFSConfiguration
default FileSystem.Builder openZFSConfiguration(Consumer<OpenZFSFileSystemConfiguration.Builder> openZFSConfiguration) The configuration for this Amazon FSx for OpenZFS file system.
This is a convenience method that creates an instance of theOpenZFSFileSystemConfiguration.Builder
avoiding the need to create one manually viaOpenZFSFileSystemConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopenZFSConfiguration(OpenZFSFileSystemConfiguration)
.- Parameters:
openZFSConfiguration
- a consumer that will call methods onOpenZFSFileSystemConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-