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.Types.FileCacheDataRepositoryAssociation

Description

Documentation

data FileCacheDataRepositoryAssociation Source #

The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA does not support automatic import or automatic export.

See: newFileCacheDataRepositoryAssociation smart constructor.

Constructors

FileCacheDataRepositoryAssociation'

Fields

dataRepositorySubdirectories :: Maybe [Text]
A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.
nfs :: Maybe FileCacheNFSConfiguration
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
fileCachePath :: Text
A path on the cache 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 cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.
This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
dataRepositoryPath :: Text
The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:
- The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
  - If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
  - If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
- The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

Instances

Instances details

ToJSON FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Methods toJSON :: FileCacheDataRepositoryAssociation -> Value # toEncoding :: FileCacheDataRepositoryAssociation -> Encoding # toJSONList :: [FileCacheDataRepositoryAssociation] -> Value # toEncodingList :: [FileCacheDataRepositoryAssociation] -> Encoding #
Generic FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Associated Types type Rep FileCacheDataRepositoryAssociation :: Type -> Type # Methods from :: FileCacheDataRepositoryAssociation -> Rep FileCacheDataRepositoryAssociation x # to :: Rep FileCacheDataRepositoryAssociation x -> FileCacheDataRepositoryAssociation #
Read FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Methods readsPrec :: Int -> ReadS FileCacheDataRepositoryAssociation # readList :: ReadS [FileCacheDataRepositoryAssociation] # readPrec :: ReadPrec FileCacheDataRepositoryAssociation # readListPrec :: ReadPrec [FileCacheDataRepositoryAssociation] #
Show FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Methods showsPrec :: Int -> FileCacheDataRepositoryAssociation -> ShowS # show :: FileCacheDataRepositoryAssociation -> String # showList :: [FileCacheDataRepositoryAssociation] -> ShowS #
NFData FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Methods rnf :: FileCacheDataRepositoryAssociation -> () #
Eq FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Methods (==) :: FileCacheDataRepositoryAssociation -> FileCacheDataRepositoryAssociation -> Bool # (/=) :: FileCacheDataRepositoryAssociation -> FileCacheDataRepositoryAssociation -> Bool #
Hashable FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation Methods hashWithSalt :: Int -> FileCacheDataRepositoryAssociation -> Int # hash :: FileCacheDataRepositoryAssociation -> Int #
type Rep FileCacheDataRepositoryAssociation Source #
Instance details Defined in Amazonka.FSx.Types.FileCacheDataRepositoryAssociation type Rep FileCacheDataRepositoryAssociation = D1 ('MetaData "FileCacheDataRepositoryAssociation" "Amazonka.FSx.Types.FileCacheDataRepositoryAssociation" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "FileCacheDataRepositoryAssociation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataRepositorySubdirectories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "nfs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileCacheNFSConfiguration))) :: (S1 ('MetaSel ('Just "fileCachePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dataRepositoryPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newFileCacheDataRepositoryAssociation Source #

Arguments

:: Text	`$sel:fileCachePath:FileCacheDataRepositoryAssociation'`
-> Text	`$sel:dataRepositoryPath:FileCacheDataRepositoryAssociation'`
-> FileCacheDataRepositoryAssociation

Create a value of FileCacheDataRepositoryAssociation 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:dataRepositorySubdirectories:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_dataRepositorySubdirectories - A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

$sel:nfs:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_nfs - The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

$sel:fileCachePath:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_fileCachePath - A path on the cache 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 cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.

The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

The cache path cannot be set to root (/) for an S3 DRA.

$sel:dataRepositoryPath:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_dataRepositoryPath - The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
- If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
- If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

fileCacheDataRepositoryAssociation_dataRepositorySubdirectories :: Lens' FileCacheDataRepositoryAssociation (Maybe [Text]) Source #

A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

fileCacheDataRepositoryAssociation_nfs :: Lens' FileCacheDataRepositoryAssociation (Maybe FileCacheNFSConfiguration) Source #

The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

fileCacheDataRepositoryAssociation_fileCachePath :: Lens' FileCacheDataRepositoryAssociation Text Source #

A path on the cache 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 cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.

The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

The cache path cannot be set to root (/) for an S3 DRA.

fileCacheDataRepositoryAssociation_dataRepositoryPath :: Lens' FileCacheDataRepositoryAssociation Text Source #

The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
- If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
- If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.