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

Amazonka.EFS.PutLifecycleConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS. For more information, see EFS Lifecycle Management.

Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and turns off lifecycle management for the file system.

In the request, specify the following:

The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.
A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

Creating a Request

data PutLifecycleConfiguration Source #

See: newPutLifecycleConfiguration smart constructor.

Constructors

PutLifecycleConfiguration'

Fields

fileSystemId :: Text
The ID of the file system for which you are creating the LifecycleConfiguration object (String).
lifecyclePolicies :: [LifecyclePolicy]
An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:
- When to move files in the file system from primary storage to the IA storage class.
- When to move files that are in IA storage to primary storage.
When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass. See the example requests in the following section for more information.

Instances

Instances details

Eq PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods (==) :: PutLifecycleConfiguration -> PutLifecycleConfiguration -> Bool # (/=) :: PutLifecycleConfiguration -> PutLifecycleConfiguration -> Bool #
Read PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods readsPrec :: Int -> ReadS PutLifecycleConfiguration # readList :: ReadS [PutLifecycleConfiguration] # readPrec :: ReadPrec PutLifecycleConfiguration # readListPrec :: ReadPrec [PutLifecycleConfiguration] #
Show PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods showsPrec :: Int -> PutLifecycleConfiguration -> ShowS # show :: PutLifecycleConfiguration -> String # showList :: [PutLifecycleConfiguration] -> ShowS #
Generic PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Associated Types type Rep PutLifecycleConfiguration :: Type -> Type # Methods from :: PutLifecycleConfiguration -> Rep PutLifecycleConfiguration x # to :: Rep PutLifecycleConfiguration x -> PutLifecycleConfiguration #
NFData PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods rnf :: PutLifecycleConfiguration -> () #
Hashable PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods hashWithSalt :: Int -> PutLifecycleConfiguration -> Int # hash :: PutLifecycleConfiguration -> Int #
ToJSON PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods toJSON :: PutLifecycleConfiguration -> Value # toEncoding :: PutLifecycleConfiguration -> Encoding # toJSONList :: [PutLifecycleConfiguration] -> Value # toEncodingList :: [PutLifecycleConfiguration] -> Encoding #
AWSRequest PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Associated Types type AWSResponse PutLifecycleConfiguration # Methods request :: PutLifecycleConfiguration -> Request PutLifecycleConfiguration # response :: MonadResource m => Logger -> Service -> Proxy PutLifecycleConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutLifecycleConfiguration))) #
ToHeaders PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods toHeaders :: PutLifecycleConfiguration -> [Header] #
ToPath PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods toPath :: PutLifecycleConfiguration -> ByteString #
ToQuery PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration Methods toQuery :: PutLifecycleConfiguration -> QueryString #
type Rep PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration type Rep PutLifecycleConfiguration = D1 ('MetaData "PutLifecycleConfiguration" "Amazonka.EFS.PutLifecycleConfiguration" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "PutLifecycleConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "lifecyclePolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [LifecyclePolicy])))
type AWSResponse PutLifecycleConfiguration Source #
Instance details Defined in Amazonka.EFS.PutLifecycleConfiguration type AWSResponse PutLifecycleConfiguration = LifecycleConfigurationDescription

newPutLifecycleConfiguration Source #

Arguments

:: Text	`$sel:fileSystemId:PutLifecycleConfiguration'`
-> PutLifecycleConfiguration

Create a value of PutLifecycleConfiguration 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:fileSystemId:PutLifecycleConfiguration', putLifecycleConfiguration_fileSystemId - The ID of the file system for which you are creating the LifecycleConfiguration object (String).

$sel:lifecyclePolicies:PutLifecycleConfiguration', putLifecycleConfiguration_lifecyclePolicies - An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

When to move files in the file system from primary storage to the IA storage class.
When to move files that are in IA storage to primary storage.

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass. See the example requests in the following section for more information.

Request Lenses

putLifecycleConfiguration_fileSystemId :: Lens' PutLifecycleConfiguration Text Source #

The ID of the file system for which you are creating the LifecycleConfiguration object (String).

putLifecycleConfiguration_lifecyclePolicies :: Lens' PutLifecycleConfiguration [LifecyclePolicy] Source #

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

When to move files in the file system from primary storage to the IA storage class.
When to move files that are in IA storage to primary storage.

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass. See the example requests in the following section for more information.

Destructuring the Response

data LifecycleConfigurationDescription Source #

See: newLifecycleConfigurationDescription smart constructor.

Constructors

LifecycleConfigurationDescription'
Fields lifecyclePolicies :: Maybe [LifecyclePolicy] An array of lifecycle management policies. EFS supports a maximum of one policy per file system.

Instances

Instances details

Eq LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Methods (==) :: LifecycleConfigurationDescription -> LifecycleConfigurationDescription -> Bool # (/=) :: LifecycleConfigurationDescription -> LifecycleConfigurationDescription -> Bool #
Read LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Methods readsPrec :: Int -> ReadS LifecycleConfigurationDescription # readList :: ReadS [LifecycleConfigurationDescription] # readPrec :: ReadPrec LifecycleConfigurationDescription # readListPrec :: ReadPrec [LifecycleConfigurationDescription] #
Show LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Methods showsPrec :: Int -> LifecycleConfigurationDescription -> ShowS # show :: LifecycleConfigurationDescription -> String # showList :: [LifecycleConfigurationDescription] -> ShowS #
Generic LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Associated Types type Rep LifecycleConfigurationDescription :: Type -> Type # Methods from :: LifecycleConfigurationDescription -> Rep LifecycleConfigurationDescription x # to :: Rep LifecycleConfigurationDescription x -> LifecycleConfigurationDescription #
NFData LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Methods rnf :: LifecycleConfigurationDescription -> () #
Hashable LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Methods hashWithSalt :: Int -> LifecycleConfigurationDescription -> Int # hash :: LifecycleConfigurationDescription -> Int #
FromJSON LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription Methods parseJSON :: Value -> Parser LifecycleConfigurationDescription # parseJSONList :: Value -> Parser [LifecycleConfigurationDescription] #
type Rep LifecycleConfigurationDescription Source #
Instance details Defined in Amazonka.EFS.Types.LifecycleConfigurationDescription type Rep LifecycleConfigurationDescription = D1 ('MetaData "LifecycleConfigurationDescription" "Amazonka.EFS.Types.LifecycleConfigurationDescription" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "LifecycleConfigurationDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lifecyclePolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LifecyclePolicy]))))

newLifecycleConfigurationDescription :: LifecycleConfigurationDescription Source #

Create a value of LifecycleConfigurationDescription 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:lifecyclePolicies:LifecycleConfigurationDescription', lifecycleConfigurationDescription_lifecyclePolicies - An array of lifecycle management policies. EFS supports a maximum of one policy per file system.

Response Lenses

lifecycleConfigurationDescription_lifecyclePolicies :: Lens' LifecycleConfigurationDescription (Maybe [LifecyclePolicy]) Source #

An array of lifecycle management policies. EFS supports a maximum of one policy per file system.