Package software.amazon.awssdk.services.fsx.model

Interface FileSystem.Builder

    • Method Detail

      • ownerId

        FileSystem.Builder ownerId​(String 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

        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, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

        Parameters:
        fileSystemType - The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.
        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, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

        Parameters:
        fileSystemType - The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.
        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. 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:
        FileSystemLifecycle, FileSystemLifecycle

      • lifecycle

        FileSystem.Builder lifecycle​(FileSystemLifecycle 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:
        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.

      • storageCapacity

        FileSystem.Builder storageCapacity​(Integer 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

        FileSystem.Builder storageType​(String storageType)

        The type of storage the file system is using. 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 type of storage the file system is using. 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 type of storage the file system is using. 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 type of storage the file system is using. 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 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

        FileSystem.Builder subnetIds​(Collection<String> 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 the PreferredSubnetID 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 the PreferredSubnetID.

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

        Parameters:
        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 the PreferredSubnetID 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 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 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

        FileSystem.Builder networkInterfaceIds​(String... 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

        FileSystem.Builder dnsName​(String 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

        FileSystem.Builder kmsKeyId​(String 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 and PERSISTENT_2 deployment types only.

          SCRATCH_1 and SCRATCH_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 and PERSISTENT_2 deployment types only.

          SCRATCH_1 and SCRATCH_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

        FileSystem.Builder resourceARN​(String 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.

      • windowsConfiguration

        FileSystem.Builder windowsConfiguration​(WindowsFileSystemConfiguration 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.

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

      • 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 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 the UpdateFileSystem operation.
        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 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 the UpdateFileSystem 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 UpdateFileSystem operation.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #administrativeActions(List).

        Parameters:
        administrativeActions - a consumer that will call methods on AdministrativeAction.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #administrativeActions(java.util.Collection)

      • ontapConfiguration

        FileSystem.Builder ontapConfiguration​(OntapFileSystemConfiguration 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.

      • fileSystemTypeVersion

        FileSystem.Builder fileSystemTypeVersion​(String fileSystemTypeVersion)

        The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

        Parameters:
        fileSystemTypeVersion - The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • openZFSConfiguration

        FileSystem.Builder openZFSConfiguration​(OpenZFSFileSystemConfiguration 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.