Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.CreateDataRepositoryAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

Synopsis

Creating a Request

data CreateDataRepositoryAssociation Source #

See: newCreateDataRepositoryAssociation smart constructor.

Constructors

CreateDataRepositoryAssociation'

Fields

batchImportMetaDataOnCreate :: Maybe Bool
Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.
clientRequestToken :: Maybe Text
fileSystemPath :: Maybe Text
A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a 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.
s3 :: Maybe S3DataRepositoryConfiguration
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
tags :: Maybe (NonEmpty Tag)
fileSystemId :: Text
dataRepositoryPath :: Text
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

Instances

Instances details

ToJSON CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods toJSON :: CreateDataRepositoryAssociation -> Value # toEncoding :: CreateDataRepositoryAssociation -> Encoding # toJSONList :: [CreateDataRepositoryAssociation] -> Value # toEncodingList :: [CreateDataRepositoryAssociation] -> Encoding #
ToHeaders CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods toHeaders :: CreateDataRepositoryAssociation -> [Header] #
ToPath CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods toPath :: CreateDataRepositoryAssociation -> ByteString #
ToQuery CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods toQuery :: CreateDataRepositoryAssociation -> QueryString #
AWSRequest CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Associated Types type AWSResponse CreateDataRepositoryAssociation # Methods request :: (Service -> Service) -> CreateDataRepositoryAssociation -> Request CreateDataRepositoryAssociation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataRepositoryAssociation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataRepositoryAssociation))) #
Generic CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Associated Types type Rep CreateDataRepositoryAssociation :: Type -> Type # Methods from :: CreateDataRepositoryAssociation -> Rep CreateDataRepositoryAssociation x # to :: Rep CreateDataRepositoryAssociation x -> CreateDataRepositoryAssociation #
Read CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods readsPrec :: Int -> ReadS CreateDataRepositoryAssociation # readList :: ReadS [CreateDataRepositoryAssociation] # readPrec :: ReadPrec CreateDataRepositoryAssociation # readListPrec :: ReadPrec [CreateDataRepositoryAssociation] #
Show CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods showsPrec :: Int -> CreateDataRepositoryAssociation -> ShowS # show :: CreateDataRepositoryAssociation -> String # showList :: [CreateDataRepositoryAssociation] -> ShowS #
NFData CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods rnf :: CreateDataRepositoryAssociation -> () #
Eq CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods (==) :: CreateDataRepositoryAssociation -> CreateDataRepositoryAssociation -> Bool # (/=) :: CreateDataRepositoryAssociation -> CreateDataRepositoryAssociation -> Bool #
Hashable CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods hashWithSalt :: Int -> CreateDataRepositoryAssociation -> Int # hash :: CreateDataRepositoryAssociation -> Int #
type AWSResponse CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation type AWSResponse CreateDataRepositoryAssociation = CreateDataRepositoryAssociationResponse
type Rep CreateDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation type Rep CreateDataRepositoryAssociation = D1 ('MetaData "CreateDataRepositoryAssociation" "Amazonka.FSx.CreateDataRepositoryAssociation" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateDataRepositoryAssociation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "batchImportMetaDataOnCreate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "fileSystemPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "importedFileChunkSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "s3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DataRepositoryConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dataRepositoryPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDataRepositoryAssociation Source #

Arguments

:: Text	`CreateDataRepositoryAssociation`
-> Text	`CreateDataRepositoryAssociation`
-> CreateDataRepositoryAssociation

Create a value of CreateDataRepositoryAssociation 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:

CreateDataRepositoryAssociation, createDataRepositoryAssociation_batchImportMetaDataOnCreate - Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.

$sel:clientRequestToken:CreateDataRepositoryAssociation', createDataRepositoryAssociation_clientRequestToken - Undocumented member.

CreateDataRepositoryAssociation, createDataRepositoryAssociation_fileSystemPath - A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

CreateDataRepositoryAssociation, createDataRepositoryAssociation_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.

CreateDataRepositoryAssociation, createDataRepositoryAssociation_s3 - The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

CreateDataRepositoryAssociation, createDataRepositoryAssociation_tags - Undocumented member.

CreateDataRepositoryAssociation, createDataRepositoryAssociation_fileSystemId - Undocumented member.

CreateDataRepositoryAssociation, createDataRepositoryAssociation_dataRepositoryPath - The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

Request Lenses

createDataRepositoryAssociation_batchImportMetaDataOnCreate :: Lens' CreateDataRepositoryAssociation (Maybe Bool) Source #

Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.

createDataRepositoryAssociation_clientRequestToken :: Lens' CreateDataRepositoryAssociation (Maybe Text) Source #

Undocumented member.

createDataRepositoryAssociation_fileSystemPath :: Lens' CreateDataRepositoryAssociation (Maybe Text) Source #

A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

createDataRepositoryAssociation_importedFileChunkSize :: Lens' CreateDataRepositoryAssociation (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.

createDataRepositoryAssociation_s3 :: Lens' CreateDataRepositoryAssociation (Maybe S3DataRepositoryConfiguration) Source #

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

createDataRepositoryAssociation_tags :: Lens' CreateDataRepositoryAssociation (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createDataRepositoryAssociation_fileSystemId :: Lens' CreateDataRepositoryAssociation Text Source #

Undocumented member.

createDataRepositoryAssociation_dataRepositoryPath :: Lens' CreateDataRepositoryAssociation Text Source #

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

Destructuring the Response

data CreateDataRepositoryAssociationResponse Source #

See: newCreateDataRepositoryAssociationResponse smart constructor.

Constructors

CreateDataRepositoryAssociationResponse'
Fields association :: Maybe DataRepositoryAssociation The response object returned after the data repository association is created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDataRepositoryAssociationResponse Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Associated Types type Rep CreateDataRepositoryAssociationResponse :: Type -> Type # Methods from :: CreateDataRepositoryAssociationResponse -> Rep CreateDataRepositoryAssociationResponse x # to :: Rep CreateDataRepositoryAssociationResponse x -> CreateDataRepositoryAssociationResponse #
Read CreateDataRepositoryAssociationResponse Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods readsPrec :: Int -> ReadS CreateDataRepositoryAssociationResponse # readList :: ReadS [CreateDataRepositoryAssociationResponse] # readPrec :: ReadPrec CreateDataRepositoryAssociationResponse # readListPrec :: ReadPrec [CreateDataRepositoryAssociationResponse] #
Show CreateDataRepositoryAssociationResponse Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods showsPrec :: Int -> CreateDataRepositoryAssociationResponse -> ShowS # show :: CreateDataRepositoryAssociationResponse -> String # showList :: [CreateDataRepositoryAssociationResponse] -> ShowS #
NFData CreateDataRepositoryAssociationResponse Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods rnf :: CreateDataRepositoryAssociationResponse -> () #
Eq CreateDataRepositoryAssociationResponse Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation Methods (==) :: CreateDataRepositoryAssociationResponse -> CreateDataRepositoryAssociationResponse -> Bool # (/=) :: CreateDataRepositoryAssociationResponse -> CreateDataRepositoryAssociationResponse -> Bool #
type Rep CreateDataRepositoryAssociationResponse Source #
Instance details Defined in Amazonka.FSx.CreateDataRepositoryAssociation type Rep CreateDataRepositoryAssociationResponse = D1 ('MetaData "CreateDataRepositoryAssociationResponse" "Amazonka.FSx.CreateDataRepositoryAssociation" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateDataRepositoryAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "association") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataRepositoryAssociation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDataRepositoryAssociationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDataRepositoryAssociationResponse'`
-> CreateDataRepositoryAssociationResponse

Create a value of CreateDataRepositoryAssociationResponse 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:association:CreateDataRepositoryAssociationResponse', createDataRepositoryAssociationResponse_association - The response object returned after the data repository association is created.

$sel:httpStatus:CreateDataRepositoryAssociationResponse', createDataRepositoryAssociationResponse_httpStatus - The response's http status code.

Response Lenses

createDataRepositoryAssociationResponse_association :: Lens' CreateDataRepositoryAssociationResponse (Maybe DataRepositoryAssociation) Source #

The response object returned after the data repository association is created.

createDataRepositoryAssociationResponse_httpStatus :: Lens' CreateDataRepositoryAssociationResponse Int Source #

The response's http status code.