Interface BackupVaultListMember.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<BackupVaultListMember.Builder,
,BackupVaultListMember> SdkBuilder<BackupVaultListMember.Builder,
,BackupVaultListMember> SdkPojo
- Enclosing class:
BackupVaultListMember
-
Method Summary
Modifier and TypeMethodDescriptionbackupVaultArn
(String backupVaultArn) An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.backupVaultName
(String backupVaultName) The name of a logical container where backups are stored.creationDate
(Instant creationDate) The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC).creatorRequestId
(String creatorRequestId) A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.encryptionKeyArn
(String 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
.The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault.maxRetentionDays
(Long maxRetentionDays) The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points.minRetentionDays
(Long minRetentionDays) The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points.numberOfRecoveryPoints
(Long numberOfRecoveryPoints) The number of recovery points that are stored in a backup vault.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.- Parameters:
backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
creationDate
- The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value ofCreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberOfRecoveryPoints
The number of recovery points that are stored in a backup vault.
- Parameters:
numberOfRecoveryPoints
- The number of recovery points that are stored in a backup vault.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
locked
- A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. Iftrue
, Vault Lock prevents delete and update operations on the recovery points in the selected vault.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-