Class: Aws::Backup::Types::BackupVaultListMember
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::BackupVaultListMember
- Defined in:
- gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb
Overview
Contains metadata about a backup vault.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#backup_vault_arn ⇒ String
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
. -
#backup_vault_name ⇒ String
The name of a logical container where backups are stored.
-
#creation_date ⇒ Time
The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC).
-
#creator_request_id ⇒ String
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
-
#encryption_key_arn ⇒ String
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
. -
#lock_date ⇒ Time
The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
-
#locked ⇒ Boolean
A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault.
-
#max_retention_days ⇒ Integer
The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points.
-
#min_retention_days ⇒ Integer
The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points.
-
#number_of_recovery_points ⇒ Integer
The number of recovery points that are stored in a backup vault.
-
#vault_state ⇒ String
The current state of the vault.
-
#vault_type ⇒ String
The type of vault in which the described recovery point is stored.
Instance Attribute Details
#backup_vault_arn ⇒ String
An Amazon Resource Name (ARN) that uniquely identifies a backup
vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#backup_vault_name ⇒ String
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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#creation_date ⇒ Time
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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#creator_request_id ⇒ String
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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#encryption_key_arn ⇒ String
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
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#lock_date ⇒ Time
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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#locked ⇒ Boolean
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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#max_retention_days ⇒ 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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#min_retention_days ⇒ 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.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#number_of_recovery_points ⇒ Integer
The number of recovery points that are stored in a backup vault.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#vault_state ⇒ String
The current state of the vault.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |
#vault_type ⇒ String
The type of vault in which the described recovery point is stored.
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 989 class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, :number_of_recovery_points, :locked, :min_retention_days, :max_retention_days, :lock_date) SENSITIVE = [] include Aws::Structure end |