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 |
Locks a retention rule. A locked retention rule can't be modified or deleted.
Synopsis
- data LockRule = LockRule' {}
- newLockRule :: Text -> LockConfiguration -> LockRule
- lockRule_identifier :: Lens' LockRule Text
- lockRule_lockConfiguration :: Lens' LockRule LockConfiguration
- data LockRuleResponse = LockRuleResponse' {}
- newLockRuleResponse :: Int -> LockRuleResponse
- lockRuleResponse_description :: Lens' LockRuleResponse (Maybe Text)
- lockRuleResponse_identifier :: Lens' LockRuleResponse (Maybe Text)
- lockRuleResponse_lockConfiguration :: Lens' LockRuleResponse (Maybe LockConfiguration)
- lockRuleResponse_lockState :: Lens' LockRuleResponse (Maybe LockState)
- lockRuleResponse_resourceTags :: Lens' LockRuleResponse (Maybe [ResourceTag])
- lockRuleResponse_resourceType :: Lens' LockRuleResponse (Maybe ResourceType)
- lockRuleResponse_retentionPeriod :: Lens' LockRuleResponse (Maybe RetentionPeriod)
- lockRuleResponse_status :: Lens' LockRuleResponse (Maybe RuleStatus)
- lockRuleResponse_httpStatus :: Lens' LockRuleResponse Int
Creating a Request
See: newLockRule
smart constructor.
LockRule' | |
|
Instances
Create a value of LockRule
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:
LockRule
, lockRule_identifier
- The unique ID of the retention rule.
LockRule
, lockRule_lockConfiguration
- Information about the retention rule lock configuration.
Request Lenses
lockRule_lockConfiguration :: Lens' LockRule LockConfiguration Source #
Information about the retention rule lock configuration.
Destructuring the Response
data LockRuleResponse Source #
See: newLockRuleResponse
smart constructor.
LockRuleResponse' | |
|
Instances
Create a value of LockRuleResponse
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:
LockRuleResponse
, lockRuleResponse_description
- The retention rule description.
LockRule
, lockRuleResponse_identifier
- The unique ID of the retention rule.
LockRule
, lockRuleResponse_lockConfiguration
- Information about the retention rule lock configuration.
LockRuleResponse
, lockRuleResponse_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 thelocked
andunlocked
states only; it can never transition back tonull
.
$sel:resourceTags:LockRuleResponse'
, lockRuleResponse_resourceTags
- Information about the resource tags used to identify resources that are
retained by the retention rule.
$sel:resourceType:LockRuleResponse'
, lockRuleResponse_resourceType
- The resource type retained by the retention rule.
LockRuleResponse
, lockRuleResponse_retentionPeriod
- Undocumented member.
$sel:status:LockRuleResponse'
, lockRuleResponse_status
- The state of the retention rule. Only retention rules that are in the
available
state retain resources.
$sel:httpStatus:LockRuleResponse'
, lockRuleResponse_httpStatus
- The response's http status code.
Response Lenses
lockRuleResponse_description :: Lens' LockRuleResponse (Maybe Text) Source #
The retention rule description.
lockRuleResponse_identifier :: Lens' LockRuleResponse (Maybe Text) Source #
The unique ID of the retention rule.
lockRuleResponse_lockConfiguration :: Lens' LockRuleResponse (Maybe LockConfiguration) Source #
Information about the retention rule lock configuration.
lockRuleResponse_lockState :: Lens' LockRuleResponse (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 thelocked
andunlocked
states only; it can never transition back tonull
.
lockRuleResponse_resourceTags :: Lens' LockRuleResponse (Maybe [ResourceTag]) Source #
Information about the resource tags used to identify resources that are retained by the retention rule.
lockRuleResponse_resourceType :: Lens' LockRuleResponse (Maybe ResourceType) Source #
The resource type retained by the retention rule.
lockRuleResponse_retentionPeriod :: Lens' LockRuleResponse (Maybe RetentionPeriod) Source #
Undocumented member.
lockRuleResponse_status :: Lens' LockRuleResponse (Maybe RuleStatus) Source #
The state of the retention rule. Only retention rules that are in the
available
state retain resources.
lockRuleResponse_httpStatus :: Lens' LockRuleResponse Int Source #
The response's http status code.