Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Returns metadata about a backup vault specified by its name.
Synopsis
- data DescribeBackupVault = DescribeBackupVault' {}
- newDescribeBackupVault :: Text -> DescribeBackupVault
- describeBackupVault_backupVaultName :: Lens' DescribeBackupVault Text
- data DescribeBackupVaultResponse = DescribeBackupVaultResponse' {
- lockDate :: Maybe POSIX
- maxRetentionDays :: Maybe Integer
- locked :: Maybe Bool
- creatorRequestId :: Maybe Text
- numberOfRecoveryPoints :: Maybe Integer
- backupVaultArn :: Maybe Text
- encryptionKeyArn :: Maybe Text
- creationDate :: Maybe POSIX
- backupVaultName :: Maybe Text
- minRetentionDays :: Maybe Integer
- httpStatus :: Int
- newDescribeBackupVaultResponse :: Int -> DescribeBackupVaultResponse
- describeBackupVaultResponse_lockDate :: Lens' DescribeBackupVaultResponse (Maybe UTCTime)
- describeBackupVaultResponse_maxRetentionDays :: Lens' DescribeBackupVaultResponse (Maybe Integer)
- describeBackupVaultResponse_locked :: Lens' DescribeBackupVaultResponse (Maybe Bool)
- describeBackupVaultResponse_creatorRequestId :: Lens' DescribeBackupVaultResponse (Maybe Text)
- describeBackupVaultResponse_numberOfRecoveryPoints :: Lens' DescribeBackupVaultResponse (Maybe Integer)
- describeBackupVaultResponse_backupVaultArn :: Lens' DescribeBackupVaultResponse (Maybe Text)
- describeBackupVaultResponse_encryptionKeyArn :: Lens' DescribeBackupVaultResponse (Maybe Text)
- describeBackupVaultResponse_creationDate :: Lens' DescribeBackupVaultResponse (Maybe UTCTime)
- describeBackupVaultResponse_backupVaultName :: Lens' DescribeBackupVaultResponse (Maybe Text)
- describeBackupVaultResponse_minRetentionDays :: Lens' DescribeBackupVaultResponse (Maybe Integer)
- describeBackupVaultResponse_httpStatus :: Lens' DescribeBackupVaultResponse Int
Creating a Request
data DescribeBackupVault Source #
See: newDescribeBackupVault
smart constructor.
DescribeBackupVault' | |
|
Instances
newDescribeBackupVault Source #
Create a value of DescribeBackupVault
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:backupVaultName:DescribeBackupVault'
, describeBackupVault_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. They
consist of lowercase letters, numbers, and hyphens.
Request Lenses
describeBackupVault_backupVaultName :: Lens' DescribeBackupVault Text Source #
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. They consist of lowercase letters, numbers, and hyphens.
Destructuring the Response
data DescribeBackupVaultResponse Source #
See: newDescribeBackupVaultResponse
smart constructor.
DescribeBackupVaultResponse' | |
|
Instances
newDescribeBackupVaultResponse Source #
Create a value of DescribeBackupVaultResponse
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:lockDate:DescribeBackupVaultResponse'
, describeBackupVaultResponse_lockDate
- The date and time when Backup Vault Lock configuration cannot be changed
or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of 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.
$sel:maxRetentionDays:DescribeBackupVaultResponse'
, describeBackupVaultResponse_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.
$sel:locked:DescribeBackupVaultResponse'
, describeBackupVaultResponse_locked
- A Boolean that indicates whether Backup Vault Lock is currently
protecting the backup vault. True
means that Vault Lock causes delete
or update operations on the recovery points stored in the vault to fail.
$sel:creatorRequestId:DescribeBackupVaultResponse'
, describeBackupVaultResponse_creatorRequestId
- A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice.
$sel:numberOfRecoveryPoints:DescribeBackupVaultResponse'
, describeBackupVaultResponse_numberOfRecoveryPoints
- The number of recovery points that are stored in a backup vault.
$sel:backupVaultArn:DescribeBackupVaultResponse'
, describeBackupVaultResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:encryptionKeyArn:DescribeBackupVaultResponse'
, describeBackupVaultResponse_encryptionKeyArn
- The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
$sel:creationDate:DescribeBackupVaultResponse'
, describeBackupVaultResponse_creationDate
- The date and time that a backup vault 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.
$sel:backupVaultName:DescribeBackupVault'
, describeBackupVaultResponse_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 Region where they are created. They consist of lowercase
letters, numbers, and hyphens.
$sel:minRetentionDays:DescribeBackupVaultResponse'
, describeBackupVaultResponse_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.
$sel:httpStatus:DescribeBackupVaultResponse'
, describeBackupVaultResponse_httpStatus
- The response's http status code.
Response Lenses
describeBackupVaultResponse_lockDate :: Lens' DescribeBackupVaultResponse (Maybe UTCTime) Source #
The date and time when Backup Vault Lock configuration cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of 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.
describeBackupVaultResponse_maxRetentionDays :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #
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.
describeBackupVaultResponse_locked :: Lens' DescribeBackupVaultResponse (Maybe Bool) Source #
A Boolean that indicates whether Backup Vault Lock is currently
protecting the backup vault. True
means that Vault Lock causes delete
or update operations on the recovery points stored in the vault to fail.
describeBackupVaultResponse_creatorRequestId :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
describeBackupVaultResponse_numberOfRecoveryPoints :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #
The number of recovery points that are stored in a backup vault.
describeBackupVaultResponse_backupVaultArn :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
describeBackupVaultResponse_encryptionKeyArn :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #
The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
describeBackupVaultResponse_creationDate :: Lens' DescribeBackupVaultResponse (Maybe UTCTime) Source #
The date and time that a backup vault 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.
describeBackupVaultResponse_backupVaultName :: Lens' DescribeBackupVaultResponse (Maybe Text) Source #
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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.
describeBackupVaultResponse_minRetentionDays :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #
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.
describeBackupVaultResponse_httpStatus :: Lens' DescribeBackupVaultResponse Int Source #
The response's http status code.