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

Class DataRepositoryConfiguration

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

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

See Also:

  • Method Details

    • lifecycle

      public final DataRepositoryLifecycle lifecycle()

      Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

      • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

      • AVAILABLE - The data repository is available for use.

      • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

      • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

      • FAILED - The data repository is in a terminal state that cannot be recovered.

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

      Returns:
      Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

      • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

      • AVAILABLE - The data repository is available for use.

      • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

      • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

      • FAILED - The data repository is in a terminal state that cannot be recovered.

      See Also:

    • lifecycleAsString

      public final String lifecycleAsString()

      Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

      • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

      • AVAILABLE - The data repository is available for use.

      • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

      • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

      • FAILED - The data repository is in a terminal state that cannot be recovered.

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

      Returns:
      Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

      • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

      • AVAILABLE - The data repository is available for use.

      • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

      • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

      • FAILED - The data repository is in a terminal state that cannot be recovered.

      See Also:

    • importPath

      public final String importPath()

      The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

      Returns:
      The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

    • exportPath

      public final String exportPath()

      The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

      Returns:
      The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

    • importedFileChunkSize

      public final Integer importedFileChunkSize()

      For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

      The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

      Returns:
      For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

      The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

    • autoImportPolicy

      public final AutoImportPolicyType autoImportPolicy()

      Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings 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 file and directory listings 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.

      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:
      Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings 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 file and directory listings 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.

      See Also:

    • autoImportPolicyAsString

      public final String autoImportPolicyAsString()

      Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings 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 file and directory listings 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.

      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:
      Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings 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 file and directory listings 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.

      See Also:

    • failureDetails

      public final DataRepositoryFailureDetails failureDetails()
      Returns the value of the FailureDetails property for this object.
      Returns:
      The value of the FailureDetails property for this object.

    • toBuilder

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

    • builder

      public static DataRepositoryConfiguration.Builder builder()

    • serializableBuilderClass

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