Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.EFS.CreateFileSystem

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating .
Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes .

After the file system is fully created, Amazon EFS sets its lifecycle state to available , at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget . You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works .

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Synopsis

Creating a Request

createFileSystem #

Arguments

:: Text	`cfsCreationToken`
-> CreateFileSystem

Creates a value of CreateFileSystem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cfsPerformanceMode - The PerformanceMode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. This can't be changed after the file system has been created.
cfsCreationToken - String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

data CreateFileSystem #

See: createFileSystem smart constructor.

Instances

Eq CreateFileSystem #
Methods (==) :: CreateFileSystem -> CreateFileSystem -> Bool # (/=) :: CreateFileSystem -> CreateFileSystem -> Bool #
Data CreateFileSystem #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateFileSystem -> c CreateFileSystem # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateFileSystem # toConstr :: CreateFileSystem -> Constr # dataTypeOf :: CreateFileSystem -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateFileSystem) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateFileSystem) # gmapT :: (forall b. Data b => b -> b) -> CreateFileSystem -> CreateFileSystem # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateFileSystem -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateFileSystem -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateFileSystem -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateFileSystem -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateFileSystem -> m CreateFileSystem # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateFileSystem -> m CreateFileSystem # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateFileSystem -> m CreateFileSystem #
Read CreateFileSystem #
Methods readsPrec :: Int -> ReadS CreateFileSystem # readList :: ReadS [CreateFileSystem] # readPrec :: ReadPrec CreateFileSystem # readListPrec :: ReadPrec [CreateFileSystem] #
Show CreateFileSystem #
Methods showsPrec :: Int -> CreateFileSystem -> ShowS # show :: CreateFileSystem -> String # showList :: [CreateFileSystem] -> ShowS #
Generic CreateFileSystem #
Associated Types type Rep CreateFileSystem :: * -> * # Methods from :: CreateFileSystem -> Rep CreateFileSystem x # to :: Rep CreateFileSystem x -> CreateFileSystem #
Hashable CreateFileSystem #
Methods hashWithSalt :: Int -> CreateFileSystem -> Int # hash :: CreateFileSystem -> Int #
ToJSON CreateFileSystem #
Methods toJSON :: CreateFileSystem -> Value # toEncoding :: CreateFileSystem -> Encoding # toJSONList :: [CreateFileSystem] -> Value # toEncodingList :: [CreateFileSystem] -> Encoding #
NFData CreateFileSystem #
Methods rnf :: CreateFileSystem -> () #
AWSRequest CreateFileSystem #
Associated Types type Rs CreateFileSystem :: * # Methods request :: CreateFileSystem -> Request CreateFileSystem # response :: MonadResource m => Logger -> Service -> Proxy * CreateFileSystem -> ClientResponse -> m (Response CreateFileSystem) #
ToQuery CreateFileSystem #
Methods toQuery :: CreateFileSystem -> QueryString #
ToPath CreateFileSystem #
Methods toPath :: CreateFileSystem -> ByteString #
ToHeaders CreateFileSystem #
Methods toHeaders :: CreateFileSystem -> [Header] #
type Rep CreateFileSystem #
type Rep CreateFileSystem = D1 (MetaData "CreateFileSystem" "Network.AWS.EFS.CreateFileSystem" "amazonka-efs-1.4.5-CIZ9ZRSiO7R8wPXU6nBzmB" False) (C1 (MetaCons "CreateFileSystem'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cfsPerformanceMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PerformanceMode))) (S1 (MetaSel (Just Symbol "_cfsCreationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreateFileSystem #
type Rs CreateFileSystem = FileSystemDescription

Request Lenses

cfsPerformanceMode :: Lens' CreateFileSystem (Maybe PerformanceMode) #

The PerformanceMode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. This can't be changed after the file system has been created.

cfsCreationToken :: Lens' CreateFileSystem Text #

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Destructuring the Response

fileSystemDescription #

Arguments

:: Text	`fsdOwnerId`
-> Text	`fsdCreationToken`
-> Text	`fsdFileSystemId`
-> UTCTime	`fsdCreationTime`
-> LifeCycleState	`fsdLifeCycleState`
-> Natural	`fsdNumberOfMountTargets`
-> FileSystemSize	`fsdSizeInBytes`
-> PerformanceMode	`fsdPerformanceMode`
-> FileSystemDescription

Creates a value of FileSystemDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fsdName - You can add tags to a file system, including a Name tag. For more information, see CreateTags . If the file system has a Name tag, Amazon EFS returns the value in this field.
fsdOwnerId - AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
fsdCreationToken - Opaque string specified in the request.
fsdFileSystemId - ID of the file system, assigned by Amazon EFS.
fsdCreationTime - Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
fsdLifeCycleState - Lifecycle phase of the file system.
fsdNumberOfMountTargets - Current number of mount targets that the file system has. For more information, see CreateMountTarget .
fsdSizeInBytes - Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
fsdPerformanceMode - The PerformanceMode of the file system.

data FileSystemDescription #

Description of the file system.

See: fileSystemDescription smart constructor.

Instances

Eq FileSystemDescription #
Methods (==) :: FileSystemDescription -> FileSystemDescription -> Bool # (/=) :: FileSystemDescription -> FileSystemDescription -> Bool #
Data FileSystemDescription #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FileSystemDescription -> c FileSystemDescription # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FileSystemDescription # toConstr :: FileSystemDescription -> Constr # dataTypeOf :: FileSystemDescription -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c FileSystemDescription) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FileSystemDescription) # gmapT :: (forall b. Data b => b -> b) -> FileSystemDescription -> FileSystemDescription # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FileSystemDescription -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FileSystemDescription -> r # gmapQ :: (forall d. Data d => d -> u) -> FileSystemDescription -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FileSystemDescription -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FileSystemDescription -> m FileSystemDescription # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FileSystemDescription -> m FileSystemDescription # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FileSystemDescription -> m FileSystemDescription #
Read FileSystemDescription #
Methods readsPrec :: Int -> ReadS FileSystemDescription # readList :: ReadS [FileSystemDescription] # readPrec :: ReadPrec FileSystemDescription # readListPrec :: ReadPrec [FileSystemDescription] #
Show FileSystemDescription #
Methods showsPrec :: Int -> FileSystemDescription -> ShowS # show :: FileSystemDescription -> String # showList :: [FileSystemDescription] -> ShowS #
Generic FileSystemDescription #
Associated Types type Rep FileSystemDescription :: * -> * # Methods from :: FileSystemDescription -> Rep FileSystemDescription x # to :: Rep FileSystemDescription x -> FileSystemDescription #
Hashable FileSystemDescription #
Methods hashWithSalt :: Int -> FileSystemDescription -> Int # hash :: FileSystemDescription -> Int #
FromJSON FileSystemDescription #
Methods parseJSON :: Value -> Parser FileSystemDescription # parseJSONList :: Value -> Parser [FileSystemDescription] #
NFData FileSystemDescription #
Methods rnf :: FileSystemDescription -> () #
type Rep FileSystemDescription #
type Rep FileSystemDescription = D1 (MetaData "FileSystemDescription" "Network.AWS.EFS.Types.Product" "amazonka-efs-1.4.5-CIZ9ZRSiO7R8wPXU6nBzmB" False) (C1 (MetaCons "FileSystemDescription'" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_fsdName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_fsdOwnerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((::) (S1 (MetaSel (Just Symbol "_fsdCreationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_fsdFileSystemId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((::) ((::) (S1 (MetaSel (Just Symbol "_fsdCreationTime") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 POSIX)) (S1 (MetaSel (Just Symbol "_fsdLifeCycleState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LifeCycleState))) ((::) (S1 (MetaSel (Just Symbol "_fsdNumberOfMountTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) ((::) (S1 (MetaSel (Just Symbol "_fsdSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FileSystemSize)) (S1 (MetaSel (Just Symbol "_fsdPerformanceMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PerformanceMode)))))))

Response Lenses

fsdName :: Lens' FileSystemDescription (Maybe Text) #

You can add tags to a file system, including a Name tag. For more information, see CreateTags . If the file system has a Name tag, Amazon EFS returns the value in this field.

fsdOwnerId :: Lens' FileSystemDescription Text #

AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

fsdCreationToken :: Lens' FileSystemDescription Text #

Opaque string specified in the request.

fsdFileSystemId :: Lens' FileSystemDescription Text #

ID of the file system, assigned by Amazon EFS.

fsdCreationTime :: Lens' FileSystemDescription UTCTime #

Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

fsdLifeCycleState :: Lens' FileSystemDescription LifeCycleState #

Lifecycle phase of the file system.

fsdNumberOfMountTargets :: Lens' FileSystemDescription Natural #

Current number of mount targets that the file system has. For more information, see CreateMountTarget .

fsdSizeInBytes :: Lens' FileSystemDescription FileSystemSize #

Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.

fsdPerformanceMode :: Lens' FileSystemDescription PerformanceMode #

The PerformanceMode of the file system.