/AWS1/CL_BUPBACKUPVAULTLSTME00

Contains metadata about a backup vault.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_backupvaultname TYPE /AWS1/BUPBACKUPVAULTNAME /AWS1/BUPBACKUPVAULTNAME

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

iv_backupvaultarn TYPE /AWS1/BUPARN /AWS1/BUPARN

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

iv_vaulttype TYPE /AWS1/BUPVAULTTYPE /AWS1/BUPVAULTTYPE

The type of vault in which the described recovery point is stored.

iv_vaultstate TYPE /AWS1/BUPVAULTSTATE /AWS1/BUPVAULTSTATE

The current state of the vault.

iv_creationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

iv_encryptionkeyarn TYPE /AWS1/BUPARN /AWS1/BUPARN

A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.

To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup

iv_creatorrequestid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

iv_numberofrecoverypoints TYPE /AWS1/BUPLONG2 /AWS1/BUPLONG2

The number of recovery points that are stored in a backup vault.

iv_locked TYPE /AWS1/BUPBOOLEAN /AWS1/BUPBOOLEAN

A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.

iv_minretentiondays TYPE /AWS1/BUPLONG /AWS1/BUPLONG

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

iv_maxretentiondays TYPE /AWS1/BUPLONG /AWS1/BUPLONG

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

iv_lockdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

---

Queryable Attributes

BackupVaultName

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

Accessible with the following methods

Method	Description
GET_BACKUPVAULTNAME()	Getter for BACKUPVAULTNAME, with configurable default
ASK_BACKUPVAULTNAME()	Getter for BACKUPVAULTNAME w/ exceptions if field has no val
HAS_BACKUPVAULTNAME()	Determine if BACKUPVAULTNAME has a value

BackupVaultArn

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Accessible with the following methods

Method	Description
GET_BACKUPVAULTARN()	Getter for BACKUPVAULTARN, with configurable default
ASK_BACKUPVAULTARN()	Getter for BACKUPVAULTARN w/ exceptions if field has no valu
HAS_BACKUPVAULTARN()	Determine if BACKUPVAULTARN has a value

VaultType

The type of vault in which the described recovery point is stored.

Accessible with the following methods

Method	Description
GET_VAULTTYPE()	Getter for VAULTTYPE, with configurable default
ASK_VAULTTYPE()	Getter for VAULTTYPE w/ exceptions if field has no value
HAS_VAULTTYPE()	Determine if VAULTTYPE has a value

VaultState

The current state of the vault.

Accessible with the following methods

Method	Description
GET_VAULTSTATE()	Getter for VAULTSTATE, with configurable default
ASK_VAULTSTATE()	Getter for VAULTSTATE w/ exceptions if field has no value
HAS_VAULTSTATE()	Determine if VAULTSTATE has a value

CreationDate

The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

EncryptionKeyArn

A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.

To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup

Accessible with the following methods

Method	Description
GET_ENCRYPTIONKEYARN()	Getter for ENCRYPTIONKEYARN, with configurable default
ASK_ENCRYPTIONKEYARN()	Getter for ENCRYPTIONKEYARN w/ exceptions if field has no va
HAS_ENCRYPTIONKEYARN()	Determine if ENCRYPTIONKEYARN has a value

CreatorRequestId

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Accessible with the following methods

Method	Description
GET_CREATORREQUESTID()	Getter for CREATORREQUESTID, with configurable default
ASK_CREATORREQUESTID()	Getter for CREATORREQUESTID w/ exceptions if field has no va
HAS_CREATORREQUESTID()	Determine if CREATORREQUESTID has a value

NumberOfRecoveryPoints

The number of recovery points that are stored in a backup vault.

Accessible with the following methods

Method	Description
GET_NUMBEROFRECOVERYPOINTS()	Getter for NUMBEROFRECOVERYPOINTS

Locked

A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.

Accessible with the following methods

Method	Description
GET_LOCKED()	Getter for LOCKED, with configurable default
ASK_LOCKED()	Getter for LOCKED w/ exceptions if field has no value
HAS_LOCKED()	Determine if LOCKED has a value

MinRetentionDays

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

Accessible with the following methods

Method	Description
GET_MINRETENTIONDAYS()	Getter for MINRETENTIONDAYS, with configurable default
ASK_MINRETENTIONDAYS()	Getter for MINRETENTIONDAYS w/ exceptions if field has no va
HAS_MINRETENTIONDAYS()	Determine if MINRETENTIONDAYS has a value

MaxRetentionDays

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

Accessible with the following methods

Method	Description
GET_MAXRETENTIONDAYS()	Getter for MAXRETENTIONDAYS, with configurable default
ASK_MAXRETENTIONDAYS()	Getter for MAXRETENTIONDAYS w/ exceptions if field has no va
HAS_MAXRETENTIONDAYS()	Determine if MAXRETENTIONDAYS has a value

LockDate

The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Accessible with the following methods

Method	Description
GET_LOCKDATE()	Getter for LOCKDATE, with configurable default
ASK_LOCKDATE()	Getter for LOCKDATE w/ exceptions if field has no value
HAS_LOCKDATE()	Determine if LOCKDATE 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_BACKUPVAULTLIST

TYPES TT_BACKUPVAULTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_BUPBACKUPVAULTLSTME00 WITH DEFAULT KEY
.