amazonka-rbin-2.0: Amazon Recycle Bin SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RBin.Types.RuleSummary

Description

 
Synopsis

Documentation

data RuleSummary Source #

Information about a Recycle Bin retention rule.

See: newRuleSummary smart constructor.

Constructors

RuleSummary' 

Fields

  • description :: Maybe Text

    The retention rule description.

  • identifier :: Maybe Text

    The unique ID of the retention rule.

  • lockState :: Maybe LockState

    The lock state for the retention rule.

    • locked - The retention rule is locked and can't be modified or deleted.
    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.
  • retentionPeriod :: Maybe RetentionPeriod

    Information about the retention period for which the retention rule is to retain resources.

Instances

Instances details
FromJSON RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Methods

parseJSON :: Value -> Parser RuleSummary #

parseJSONList :: Value -> Parser [RuleSummary] #

Generic RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Associated Types

type Rep RuleSummary :: Type -> Type #

Methods

from :: RuleSummary -> Rep RuleSummary x #

to :: Rep RuleSummary x -> RuleSummary #

Read RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Methods

readsPrec :: Int -> ReadS RuleSummary #

readList :: ReadS [RuleSummary] #

readPrec :: ReadPrec RuleSummary #

readListPrec :: ReadPrec [RuleSummary] #

Show RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Methods

showsPrec :: Int -> RuleSummary -> ShowS #

show :: RuleSummary -> String #

showList :: [RuleSummary] -> ShowS #

NFData RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Methods

rnf :: RuleSummary -> () #

Eq RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Methods

(==) :: RuleSummary -> RuleSummary -> Bool #

(/=) :: RuleSummary -> RuleSummary -> Bool #

Hashable RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

Methods

hashWithSalt :: Int -> RuleSummary -> Int #

hash :: RuleSummary -> Int #

type Rep RuleSummary Source # 
Instance details

Defined in Amazonka.RBin.Types.RuleSummary

type Rep RuleSummary = D1 ('MetaData "RuleSummary" "Amazonka.RBin.Types.RuleSummary" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "RuleSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lockState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockState)) :*: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)))))

newRuleSummary :: RuleSummary Source #

Create a value of RuleSummary 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:description:RuleSummary', ruleSummary_description - The retention rule description.

$sel:identifier:RuleSummary', ruleSummary_identifier - The unique ID of the retention rule.

$sel:lockState:RuleSummary', ruleSummary_lockState - The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.
  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

$sel:retentionPeriod:RuleSummary', ruleSummary_retentionPeriod - Information about the retention period for which the retention rule is to retain resources.

ruleSummary_description :: Lens' RuleSummary (Maybe Text) Source #

The retention rule description.

ruleSummary_identifier :: Lens' RuleSummary (Maybe Text) Source #

The unique ID of the retention rule.

ruleSummary_lockState :: Lens' RuleSummary (Maybe LockState) Source #

The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.
  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

ruleSummary_retentionPeriod :: Lens' RuleSummary (Maybe RetentionPeriod) Source #

Information about the retention period for which the retention rule is to retain resources.