amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.DescribeBackupVault

Description

Returns metadata about a backup vault specified by its name.

Synopsis

Creating a Request

data DescribeBackupVault Source #

See: newDescribeBackupVault smart constructor.

Constructors

DescribeBackupVault' 

Fields

  • backupVaultName :: Text

    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.

Instances

Instances details
ToHeaders DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

ToPath DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

ToQuery DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

AWSRequest DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Associated Types

type AWSResponse DescribeBackupVault #

Generic DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Associated Types

type Rep DescribeBackupVault :: Type -> Type #

Read DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Show DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

NFData DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Methods

rnf :: DescribeBackupVault -> () #

Eq DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Hashable DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

type AWSResponse DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

type Rep DescribeBackupVault Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

type Rep DescribeBackupVault = D1 ('MetaData "DescribeBackupVault" "Amazonka.Backup.DescribeBackupVault" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DescribeBackupVault'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

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:

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.

Constructors

DescribeBackupVaultResponse' 

Fields

  • backupVaultArn :: Maybe Text

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

  • backupVaultName :: Maybe Text

    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.

  • creationDate :: Maybe POSIX

    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.

  • creatorRequestId :: Maybe Text

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

  • encryptionKeyArn :: Maybe Text

    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.

  • lockDate :: Maybe POSIX

    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.

  • locked :: Maybe Bool

    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.

  • maxRetentionDays :: Maybe Integer

    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.

  • minRetentionDays :: Maybe Integer

    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.

  • numberOfRecoveryPoints :: Maybe Integer

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeBackupVaultResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Associated Types

type Rep DescribeBackupVaultResponse :: Type -> Type #

Read DescribeBackupVaultResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Show DescribeBackupVaultResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

NFData DescribeBackupVaultResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

Eq DescribeBackupVaultResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

type Rep DescribeBackupVaultResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeBackupVault

type Rep DescribeBackupVaultResponse = D1 ('MetaData "DescribeBackupVaultResponse" "Amazonka.Backup.DescribeBackupVault" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DescribeBackupVaultResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "backupVaultArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryptionKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "lockDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "locked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxRetentionDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "minRetentionDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "numberOfRecoveryPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

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:

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.

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.

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.

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.

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.

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.

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.

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.

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.

DescribeBackupVaultResponse, describeBackupVaultResponse_numberOfRecoveryPoints - The number of recovery points that are stored in a backup vault.

$sel:httpStatus:DescribeBackupVaultResponse', describeBackupVaultResponse_httpStatus - The response's http status code.

Response Lenses

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_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_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_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_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_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_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_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_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_numberOfRecoveryPoints :: Lens' DescribeBackupVaultResponse (Maybe Integer) Source #

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