Class UpdateFileSystemLustreConfiguration

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

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

See Also:

  • Method Details

    • weeklyMaintenanceStartTime

      public final String weeklyMaintenanceStartTime()

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

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

    • 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()

      The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

      Returns:
      The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

    • autoImportPolicy

      public final AutoImportPolicyType autoImportPolicy()

      (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

      • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.

      • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

      • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

      • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

      This parameter is not supported for file systems with a data repository association.

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

      Returns:
      (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

      • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.

      • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

      • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

      • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

      This parameter is not supported for file systems with a data repository association.

      See Also:

    • autoImportPolicyAsString

      public final String autoImportPolicyAsString()

      (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

      • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.

      • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

      • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

      • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

      This parameter is not supported for file systems with a data repository association.

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

      Returns:
      (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

      • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.

      • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

      • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

      • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

      This parameter is not supported for file systems with a data repository association.

      See Also:

    • dataCompressionType

      public final DataCompressionType dataCompressionType()

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

      If you don't use DataCompressionType, the file system retains its current data compression configuration.

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

      If you don't use DataCompressionType, the file system retains its current data compression configuration.

      For more information, see Lustre data compression.

      See Also:

    • dataCompressionTypeAsString

      public final String dataCompressionTypeAsString()

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

      If you don't use DataCompressionType, the file system retains its current data compression configuration.

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

      If you don't use DataCompressionType, the file system retains its current data compression configuration.

      For more information, see Lustre data compression.

      See Also:

    • logConfiguration

      public final LustreLogCreateConfiguration logConfiguration()

      The Lustre logging configuration used when updating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

      Returns:
      The Lustre logging configuration used when updating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

    • rootSquashConfiguration

      public final LustreRootSquashConfiguration rootSquashConfiguration()

      The Lustre root squash configuration used when updating 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 used when updating 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.

    • perUnitStorageThroughput

      public final Integer perUnitStorageThroughput()

      The throughput of an Amazon FSx for Lustre Persistent SSD-based file system, measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease your file system's throughput. Valid values depend on the deployment type of the file system, as follows:

      • For PERSISTENT_1 SSD-based deployment types, valid values are 50, 100, and 200 MB/s/TiB.

      • For PERSISTENT_2 SSD-based deployment types, valid values are 125, 250, 500, and 1000 MB/s/TiB.

      For more information, see Managing throughput capacity.

      Returns:
      The throughput of an Amazon FSx for Lustre Persistent SSD-based file system, measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease your file system's throughput. Valid values depend on the deployment type of the file system, as follows:

      • For PERSISTENT_1 SSD-based deployment types, valid values are 50, 100, and 200 MB/s/TiB.

      • For PERSISTENT_2 SSD-based deployment types, valid values are 125, 250, 500, and 1000 MB/s/TiB.

      For more information, see Managing throughput capacity.

    • metadataConfiguration

      public final UpdateFileSystemLustreMetadataConfiguration metadataConfiguration()

      The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. When this configuration is enabled, the file system supports increasing metadata performance.

      Returns:
      The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. When this configuration is enabled, the file system supports increasing metadata performance.

    • throughputCapacity

      public final Integer throughputCapacity()

      The throughput of an Amazon FSx for Lustre file system using an Intelligent-Tiering storage class, measured in megabytes per second (MBps). You can only increase your file system's throughput. Valid values are 4000 MBps or multiples of 4000 MBps.

      Returns:
      The throughput of an Amazon FSx for Lustre file system using an Intelligent-Tiering storage class, measured in megabytes per second (MBps). You can only increase your file system's throughput. Valid values are 4000 MBps or multiples of 4000 MBps.

    • dataReadCacheConfiguration

      public final LustreReadCacheConfiguration dataReadCacheConfiguration()

      Specifies the optional provisioned SSD read cache on Amazon FSx for Lustre file systems that use the Intelligent-Tiering storage class.

      Returns:
      Specifies the optional provisioned SSD read cache on Amazon FSx for Lustre file systems that use the Intelligent-Tiering storage class.

    • toBuilder

      public UpdateFileSystemLustreConfiguration.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<UpdateFileSystemLustreConfiguration.Builder,UpdateFileSystemLustreConfiguration>
      Returns:
      a builder for type T

    • builder

      public static UpdateFileSystemLustreConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFileSystemLustreConfiguration.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.