/AWS1/CL_BUPLEGALHOLD¶
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_title TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
The title of a legal hold.
iv_status TYPE /AWS1/BUPLEGALHOLDSTATUS /AWS1/BUPLEGALHOLDSTATUS¶
The status of the legal hold.
iv_description TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
The description of a legal hold.
iv_legalholdid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
The ID of the legal hold.
iv_legalholdarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
The Amazon Resource Name (ARN) of the legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
iv_creationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The time when the legal hold was created.
iv_cancellationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The time when the legal hold was cancelled.
Queryable Attributes¶
Title¶
The title of a legal hold.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
Status¶
The status of the legal hold.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
Description¶
The description of a legal hold.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
LegalHoldId¶
The ID of the legal hold.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LEGALHOLDID() |
Getter for LEGALHOLDID, with configurable default |
ASK_LEGALHOLDID() |
Getter for LEGALHOLDID w/ exceptions if field has no value |
HAS_LEGALHOLDID() |
Determine if LEGALHOLDID has a value |
LegalHoldArn¶
The Amazon Resource Name (ARN) of the legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LEGALHOLDARN() |
Getter for LEGALHOLDARN, with configurable default |
ASK_LEGALHOLDARN() |
Getter for LEGALHOLDARN w/ exceptions if field has no value |
HAS_LEGALHOLDARN() |
Determine if LEGALHOLDARN has a value |
CreationDate¶
The time when the legal hold was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
CancellationDate¶
The time when the legal hold was cancelled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CANCELLATIONDATE() |
Getter for CANCELLATIONDATE, with configurable default |
ASK_CANCELLATIONDATE() |
Getter for CANCELLATIONDATE w/ exceptions if field has no va |
HAS_CANCELLATIONDATE() |
Determine if CANCELLATIONDATE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_LEGALHOLDSLIST¶
TYPES TT_LEGALHOLDSLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_BUPLEGALHOLD WITH DEFAULT KEY
.