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.CreateFileCache

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Amazon File Cache resource.

You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the cache in JSON format.

The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.

Synopsis

Creating a Request

data CreateFileCache Source #

See: newCreateFileCache smart constructor.

Constructors

CreateFileCache'

Fields

clientRequestToken :: Maybe Text
An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.
copyTagsToDataRepositoryAssociations :: Maybe Bool
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
dataRepositoryAssociations :: Maybe [FileCacheDataRepositoryAssociation]
A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
- All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
- An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
kmsKeyId :: Maybe Text
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
lustreConfiguration :: Maybe CreateFileCacheLustreConfiguration
The configuration for the Amazon File Cache resource being created.
securityGroupIds :: Maybe [Text]
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
tags :: Maybe (NonEmpty Tag)
fileCacheType :: FileCacheType
The type of cache that you're creating, which must be LUSTRE.
fileCacheTypeVersion :: Text
Sets the Lustre version for the cache that you're creating, which must be 2.12.
storageCapacity :: Natural
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
subnetIds :: [Text]

Instances

Instances details

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

newCreateFileCache Source #

Arguments

:: FileCacheType	`CreateFileCache`
-> Text	`CreateFileCache`
-> Natural	`CreateFileCache`
-> CreateFileCache

Create a value of CreateFileCache 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:clientRequestToken:CreateFileCache', createFileCache_clientRequestToken - An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

CreateFileCache, createFileCache_copyTagsToDataRepositoryAssociations - A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

$sel:dataRepositoryAssociations:CreateFileCache', createFileCache_dataRepositoryAssociations - A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA configurations must meet the following requirements:

All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

DRA automatic import and automatic export is not supported.

CreateFileCache, createFileCache_kmsKeyId - Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

CreateFileCache, createFileCache_lustreConfiguration - The configuration for the Amazon File Cache resource being created.

$sel:securityGroupIds:CreateFileCache', createFileCache_securityGroupIds - A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.

CreateFileCache, createFileCache_tags - Undocumented member.

CreateFileCache, createFileCache_fileCacheType - The type of cache that you're creating, which must be LUSTRE.

CreateFileCache, createFileCache_fileCacheTypeVersion - Sets the Lustre version for the cache that you're creating, which must be 2.12.

CreateFileCache, createFileCache_storageCapacity - The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

CreateFileCache, createFileCache_subnetIds - Undocumented member.

Request Lenses

createFileCache_clientRequestToken :: Lens' CreateFileCache (Maybe Text) Source #

An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

createFileCache_copyTagsToDataRepositoryAssociations :: Lens' CreateFileCache (Maybe Bool) Source #

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

createFileCache_dataRepositoryAssociations :: Lens' CreateFileCache (Maybe [FileCacheDataRepositoryAssociation]) Source #

A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA configurations must meet the following requirements:

All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

DRA automatic import and automatic export is not supported.

createFileCache_kmsKeyId :: Lens' CreateFileCache (Maybe Text) Source #

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

createFileCache_lustreConfiguration :: Lens' CreateFileCache (Maybe CreateFileCacheLustreConfiguration) Source #

The configuration for the Amazon File Cache resource being created.

createFileCache_securityGroupIds :: Lens' CreateFileCache (Maybe [Text]) Source #

A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.

createFileCache_tags :: Lens' CreateFileCache (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createFileCache_fileCacheType :: Lens' CreateFileCache FileCacheType Source #

The type of cache that you're creating, which must be LUSTRE.

createFileCache_fileCacheTypeVersion :: Lens' CreateFileCache Text Source #

Sets the Lustre version for the cache that you're creating, which must be 2.12.

createFileCache_storageCapacity :: Lens' CreateFileCache Natural Source #

The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

createFileCache_subnetIds :: Lens' CreateFileCache [Text] Source #

Undocumented member.

Destructuring the Response

data CreateFileCacheResponse Source #

See: newCreateFileCacheResponse smart constructor.

Constructors

CreateFileCacheResponse'
Fields fileCache :: Maybe FileCacheCreating A description of the cache that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateFileCacheResponse Source #

Arguments

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

Create a value of CreateFileCacheResponse 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:fileCache:CreateFileCacheResponse', createFileCacheResponse_fileCache - A description of the cache that was created.

$sel:httpStatus:CreateFileCacheResponse', createFileCacheResponse_httpStatus - The response's http status code.

Response Lenses

createFileCacheResponse_fileCache :: Lens' CreateFileCacheResponse (Maybe FileCacheCreating) Source #

A description of the cache that was created.

createFileCacheResponse_httpStatus :: Lens' CreateFileCacheResponse Int Source #

The response's http status code.