amazonka-fsx-2.0: Amazon FSx SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FSx.Types.DataRepositoryConfiguration

Description

 
Synopsis

Documentation

data DataRepositoryConfiguration Source #

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

This data type is not supported for file systems with the Persistent_2 deployment type. Instead, use .

See: newDataRepositoryConfiguration smart constructor.

Constructors

DataRepositoryConfiguration' 

Fields

  • autoImportPolicy :: Maybe AutoImportPolicyType

    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.
  • exportPath :: Maybe Text

    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.

  • failureDetails :: Maybe DataRepositoryFailureDetails
     
  • importPath :: Maybe Text

    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.

  • importedFileChunkSize :: Maybe Natural

    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.

  • lifecycle :: Maybe DataRepositoryLifecycle

    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.

Instances

Instances details
FromJSON DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

Generic DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

Associated Types

type Rep DataRepositoryConfiguration :: Type -> Type #

Read DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

Show DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

NFData DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

Eq DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

Hashable DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

type Rep DataRepositoryConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.DataRepositoryConfiguration

type Rep DataRepositoryConfiguration = D1 ('MetaData "DataRepositoryConfiguration" "Amazonka.FSx.Types.DataRepositoryConfiguration" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DataRepositoryConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoImportPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoImportPolicyType)) :*: (S1 ('MetaSel ('Just "exportPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataRepositoryFailureDetails)))) :*: (S1 ('MetaSel ('Just "importPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "importedFileChunkSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataRepositoryLifecycle))))))

newDataRepositoryConfiguration :: DataRepositoryConfiguration Source #

Create a value of DataRepositoryConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoImportPolicy:DataRepositoryConfiguration', dataRepositoryConfiguration_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.

$sel:exportPath:DataRepositoryConfiguration', dataRepositoryConfiguration_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.

$sel:failureDetails:DataRepositoryConfiguration', dataRepositoryConfiguration_failureDetails - Undocumented member.

$sel:importPath:DataRepositoryConfiguration', dataRepositoryConfiguration_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.

$sel:importedFileChunkSize:DataRepositoryConfiguration', dataRepositoryConfiguration_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.

$sel:lifecycle:DataRepositoryConfiguration', dataRepositoryConfiguration_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.

dataRepositoryConfiguration_autoImportPolicy :: Lens' DataRepositoryConfiguration (Maybe AutoImportPolicyType) Source #

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.

dataRepositoryConfiguration_exportPath :: Lens' DataRepositoryConfiguration (Maybe Text) Source #

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.

dataRepositoryConfiguration_importPath :: Lens' DataRepositoryConfiguration (Maybe Text) Source #

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.

dataRepositoryConfiguration_importedFileChunkSize :: Lens' DataRepositoryConfiguration (Maybe Natural) Source #

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.

dataRepositoryConfiguration_lifecycle :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryLifecycle) Source #

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.