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

Interface LustreFileSystemConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LustreFileSystemConfiguration.Builder,LustreFileSystemConfiguration>, SdkBuilder<LustreFileSystemConfiguration.Builder,LustreFileSystemConfiguration>, SdkPojo
Enclosing class:
LustreFileSystemConfiguration
public static interface LustreFileSystemConfiguration.Builder extends SdkPojo, CopyableBuilder<LustreFileSystemConfiguration.Builder,LustreFileSystemConfiguration>

  • Method Details

    • weeklyMaintenanceStartTime

      LustreFileSystemConfiguration.Builder weeklyMaintenanceStartTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dataRepositoryConfiguration

      LustreFileSystemConfiguration.Builder dataRepositoryConfiguration(DataRepositoryConfiguration dataRepositoryConfiguration)
      Sets the value of the DataRepositoryConfiguration property for this object.
      Parameters:
      dataRepositoryConfiguration - The new value for the DataRepositoryConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataRepositoryConfiguration

      default LustreFileSystemConfiguration.Builder dataRepositoryConfiguration(Consumer<DataRepositoryConfiguration.Builder> dataRepositoryConfiguration)
      Sets the value of the DataRepositoryConfiguration property for this object. This is a convenience method that creates an instance of the DataRepositoryConfiguration.Builder avoiding the need to create one manually via DataRepositoryConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataRepositoryConfiguration(DataRepositoryConfiguration).

      Parameters:
      dataRepositoryConfiguration - a consumer that will call methods on DataRepositoryConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deploymentType

      LustreFileSystemConfiguration.Builder deploymentType(String 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.

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

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

    • deploymentType

      LustreFileSystemConfiguration.Builder deploymentType(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.

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

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

    • perUnitStorageThroughput

      LustreFileSystemConfiguration.Builder perUnitStorageThroughput(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • mountName

      LustreFileSystemConfiguration.Builder mountName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dailyAutomaticBackupStartTime

      LustreFileSystemConfiguration.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)
      Sets the value of the DailyAutomaticBackupStartTime property for this object.
      Parameters:
      dailyAutomaticBackupStartTime - The new value for the DailyAutomaticBackupStartTime property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • automaticBackupRetentionDays

      LustreFileSystemConfiguration.Builder automaticBackupRetentionDays(Integer automaticBackupRetentionDays)
      Sets the value of the AutomaticBackupRetentionDays property for this object.
      Parameters:
      automaticBackupRetentionDays - The new value for the AutomaticBackupRetentionDays property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copyTagsToBackups

      LustreFileSystemConfiguration.Builder copyTagsToBackups(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)

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • driveCacheType

      LustreFileSystemConfiguration.Builder driveCacheType(String 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.

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

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

    • driveCacheType

      LustreFileSystemConfiguration.Builder driveCacheType(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.

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

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

    • dataCompressionType

      LustreFileSystemConfiguration.Builder dataCompressionType(String 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.

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

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

    • dataCompressionType

      LustreFileSystemConfiguration.Builder dataCompressionType(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.

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

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

    • logConfiguration

      LustreFileSystemConfiguration.Builder logConfiguration(LustreLogConfiguration logConfiguration)

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

      Parameters:
      logConfiguration - The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfiguration

      default LustreFileSystemConfiguration.Builder logConfiguration(Consumer<LustreLogConfiguration.Builder> logConfiguration)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfiguration(LustreLogConfiguration).

      Parameters:
      logConfiguration - a consumer that will call methods on LustreLogConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rootSquashConfiguration

      LustreFileSystemConfiguration.Builder rootSquashConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • rootSquashConfiguration

      default LustreFileSystemConfiguration.Builder rootSquashConfiguration(Consumer<LustreRootSquashConfiguration.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rootSquashConfiguration(LustreRootSquashConfiguration).

      Parameters:
      rootSquashConfiguration - a consumer that will call methods on LustreRootSquashConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadataConfiguration

      LustreFileSystemConfiguration.Builder metadataConfiguration(FileSystemLustreMetadataConfiguration metadataConfiguration)

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

      Parameters:
      metadataConfiguration - The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataConfiguration

      default LustreFileSystemConfiguration.Builder metadataConfiguration(Consumer<FileSystemLustreMetadataConfiguration.Builder> metadataConfiguration)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataConfiguration(FileSystemLustreMetadataConfiguration).

      Parameters:
      metadataConfiguration - a consumer that will call methods on FileSystemLustreMetadataConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: