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

Class LustreFileSystemConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.LustreFileSystemConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LustreFileSystemConfiguration.Builder,LustreFileSystemConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class LustreFileSystemConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LustreFileSystemConfiguration.Builder,LustreFileSystemConfiguration>

The configuration for the Amazon FSx for Lustre file system.

See Also:

  • Method Details

    • weeklyMaintenanceStartTime

      public final String weeklyMaintenanceStartTime()

      The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

      Returns:
      The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

    • dataRepositoryConfiguration

      public final DataRepositoryConfiguration dataRepositoryConfiguration()
      Returns the value of the DataRepositoryConfiguration property for this object.
      Returns:
      The value of the DataRepositoryConfiguration property for this object.

    • deploymentType

      public final LustreDeploymentType deploymentType()

      The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

      SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

      The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

      The default is SCRATCH_1.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return LustreDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

      Returns:
      The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

      SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

      The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

      The default is SCRATCH_1.

      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

      SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

      The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

      The default is SCRATCH_1.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return LustreDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

      Returns:
      The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

      SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

      The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

      The default is SCRATCH_1.

      See Also:

    • perUnitStorageThroughput

      public final Integer perUnitStorageThroughput()

      Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

      Valid values:

      • For PERSISTENT_1 SSD storage: 50, 100, 200.

      • For PERSISTENT_1 HDD storage: 12, 40.

      • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

      Returns:
      Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

      Valid values:

      • For PERSISTENT_1 SSD storage: 50, 100, 200.

      • For PERSISTENT_1 HDD storage: 12, 40.

      • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

    • mountName

      public final String mountName()

      You use the MountName value when mounting the file system.

      For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

      Returns:
      You use the MountName value when mounting the file system.

      For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

    • dailyAutomaticBackupStartTime

      public final String dailyAutomaticBackupStartTime()
      Returns the value of the DailyAutomaticBackupStartTime property for this object.
      Returns:
      The value of the DailyAutomaticBackupStartTime property for this object.

    • automaticBackupRetentionDays

      public final Integer automaticBackupRetentionDays()
      Returns the value of the AutomaticBackupRetentionDays property for this object.
      Returns:
      The value of the AutomaticBackupRetentionDays property for this object.

    • copyTagsToBackups

      public final Boolean copyTagsToBackups()

      A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

      Returns:
      A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

    • driveCacheType

      public final DriveCacheType driveCacheType()

      The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

      This parameter is required when StorageType is set to HDD.

      If the service returns an enum value that is not available in the current SDK version, driveCacheType will return DriveCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from driveCacheTypeAsString().

      Returns:
      The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

      This parameter is required when StorageType is set to HDD.

      See Also:

    • driveCacheTypeAsString

      public final String driveCacheTypeAsString()

      The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

      This parameter is required when StorageType is set to HDD.

      If the service returns an enum value that is not available in the current SDK version, driveCacheType will return DriveCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from driveCacheTypeAsString().

      Returns:
      The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

      This parameter is required when StorageType is set to HDD.

      See Also:

    • dataCompressionType

      public final DataCompressionType dataCompressionType()

      The data compression configuration for the file system. DataCompressionType can have the following values:

      • NONE - Data compression is turned off for the file system.

      • LZ4 - Data compression is turned on with the LZ4 algorithm.

      For more information, see Lustre data compression.

      If the service returns an enum value that is not available in the current SDK version, dataCompressionType will return DataCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataCompressionTypeAsString().

      Returns:
      The data compression configuration for the file system. DataCompressionType can have the following values:

      • NONE - Data compression is turned off for the file system.

      • LZ4 - Data compression is turned on with the LZ4 algorithm.

      For more information, see Lustre data compression.

      See Also:

    • dataCompressionTypeAsString

      public final String dataCompressionTypeAsString()

      The data compression configuration for the file system. DataCompressionType can have the following values:

      • NONE - Data compression is turned off for the file system.

      • LZ4 - Data compression is turned on with the LZ4 algorithm.

      For more information, see Lustre data compression.

      If the service returns an enum value that is not available in the current SDK version, dataCompressionType will return DataCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataCompressionTypeAsString().

      Returns:
      The data compression configuration for the file system. DataCompressionType can have the following values:

      • NONE - Data compression is turned off for the file system.

      • LZ4 - Data compression is turned on with the LZ4 algorithm.

      For more information, see Lustre data compression.

      See Also:

    • logConfiguration

      public final LustreLogConfiguration logConfiguration()

      The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

      Returns:
      The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

    • rootSquashConfiguration

      public final LustreRootSquashConfiguration rootSquashConfiguration()

      The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

      Returns:
      The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

    • metadataConfiguration

      public final FileSystemLustreMetadataConfiguration metadataConfiguration()

      The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

      Returns:
      The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

    • toBuilder

      public LustreFileSystemConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LustreFileSystemConfiguration.Builder,LustreFileSystemConfiguration>
      Returns:
      a builder for type T

    • builder

      public static LustreFileSystemConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LustreFileSystemConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.