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.Backup.CreateLegalHold
Description
This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
Synopsis
- data CreateLegalHold = CreateLegalHold' {}
- newCreateLegalHold :: Text -> Text -> CreateLegalHold
- createLegalHold_idempotencyToken :: Lens' CreateLegalHold (Maybe Text)
- createLegalHold_recoveryPointSelection :: Lens' CreateLegalHold (Maybe RecoveryPointSelection)
- createLegalHold_tags :: Lens' CreateLegalHold (Maybe (HashMap Text Text))
- createLegalHold_title :: Lens' CreateLegalHold Text
- createLegalHold_description :: Lens' CreateLegalHold Text
- data CreateLegalHoldResponse = CreateLegalHoldResponse' {}
- newCreateLegalHoldResponse :: Int -> CreateLegalHoldResponse
- createLegalHoldResponse_creationDate :: Lens' CreateLegalHoldResponse (Maybe UTCTime)
- createLegalHoldResponse_description :: Lens' CreateLegalHoldResponse (Maybe Text)
- createLegalHoldResponse_legalHoldArn :: Lens' CreateLegalHoldResponse (Maybe Text)
- createLegalHoldResponse_legalHoldId :: Lens' CreateLegalHoldResponse (Maybe Text)
- createLegalHoldResponse_recoveryPointSelection :: Lens' CreateLegalHoldResponse (Maybe RecoveryPointSelection)
- createLegalHoldResponse_status :: Lens' CreateLegalHoldResponse (Maybe LegalHoldStatus)
- createLegalHoldResponse_title :: Lens' CreateLegalHoldResponse (Maybe Text)
- createLegalHoldResponse_httpStatus :: Lens' CreateLegalHoldResponse Int
Creating a Request
data CreateLegalHold Source #
See: newCreateLegalHold
smart constructor.
Constructors
CreateLegalHold' | |
Fields
|
Instances
Arguments
:: Text | |
-> Text | |
-> CreateLegalHold |
Create a value of CreateLegalHold
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:idempotencyToken:CreateLegalHold'
, createLegalHold_idempotencyToken
- This is a user-chosen string used to distinguish between otherwise
identical calls. Retrying a successful request with the same idempotency
token results in a success message with no action taken.
CreateLegalHold
, createLegalHold_recoveryPointSelection
- This specifies criteria to assign a set of resources, such as resource
types or backup vaults.
CreateLegalHold
, createLegalHold_tags
- Optional tags to include. A tag is a key-value pair you can use to
manage, filter, and search for your resources. Allowed characters
include UTF-8 letters, numbers, spaces, and the following characters: +
- = . _ : /.
CreateLegalHold
, createLegalHold_title
- This is the string title of the legal hold.
CreateLegalHold
, createLegalHold_description
- This is the string description of the legal hold.
Request Lenses
createLegalHold_idempotencyToken :: Lens' CreateLegalHold (Maybe Text) Source #
This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
createLegalHold_recoveryPointSelection :: Lens' CreateLegalHold (Maybe RecoveryPointSelection) Source #
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
createLegalHold_tags :: Lens' CreateLegalHold (Maybe (HashMap Text Text)) Source #
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
createLegalHold_title :: Lens' CreateLegalHold Text Source #
This is the string title of the legal hold.
createLegalHold_description :: Lens' CreateLegalHold Text Source #
This is the string description of the legal hold.
Destructuring the Response
data CreateLegalHoldResponse Source #
See: newCreateLegalHoldResponse
smart constructor.
Constructors
CreateLegalHoldResponse' | |
Fields
|
Instances
newCreateLegalHoldResponse Source #
Create a value of CreateLegalHoldResponse
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:
CreateLegalHoldResponse
, createLegalHoldResponse_creationDate
- Time in number format when legal hold was created.
CreateLegalHold
, createLegalHoldResponse_description
- This is the returned string description of the legal hold.
CreateLegalHoldResponse
, createLegalHoldResponse_legalHoldArn
- This is the ARN (Amazon Resource Number) of the created legal hold.
CreateLegalHoldResponse
, createLegalHoldResponse_legalHoldId
- Legal hold ID returned for the specified legal hold on a recovery point.
CreateLegalHold
, createLegalHoldResponse_recoveryPointSelection
- This specifies criteria to assign a set of resources, such as resource
types or backup vaults.
CreateLegalHoldResponse
, createLegalHoldResponse_status
- This displays the status of the legal hold returned after creating the
legal hold. Statuses can be ACTIVE
, PENDING
, CANCELED
,
CANCELING
, or FAILED
.
CreateLegalHold
, createLegalHoldResponse_title
- This is the string title of the legal hold returned after creating the
legal hold.
$sel:httpStatus:CreateLegalHoldResponse'
, createLegalHoldResponse_httpStatus
- The response's http status code.
Response Lenses
createLegalHoldResponse_creationDate :: Lens' CreateLegalHoldResponse (Maybe UTCTime) Source #
Time in number format when legal hold was created.
createLegalHoldResponse_description :: Lens' CreateLegalHoldResponse (Maybe Text) Source #
This is the returned string description of the legal hold.
createLegalHoldResponse_legalHoldArn :: Lens' CreateLegalHoldResponse (Maybe Text) Source #
This is the ARN (Amazon Resource Number) of the created legal hold.
createLegalHoldResponse_legalHoldId :: Lens' CreateLegalHoldResponse (Maybe Text) Source #
Legal hold ID returned for the specified legal hold on a recovery point.
createLegalHoldResponse_recoveryPointSelection :: Lens' CreateLegalHoldResponse (Maybe RecoveryPointSelection) Source #
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
createLegalHoldResponse_status :: Lens' CreateLegalHoldResponse (Maybe LegalHoldStatus) Source #
This displays the status of the legal hold returned after creating the
legal hold. Statuses can be ACTIVE
, PENDING
, CANCELED
,
CANCELING
, or FAILED
.
createLegalHoldResponse_title :: Lens' CreateLegalHoldResponse (Maybe Text) Source #
This is the string title of the legal hold returned after creating the legal hold.
createLegalHoldResponse_httpStatus :: Lens' CreateLegalHoldResponse Int Source #
The response's http status code.