Interface DescribeBackupVaultResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,BackupResponse.Builder
,Buildable
,CopyableBuilder<DescribeBackupVaultResponse.Builder,
,DescribeBackupVaultResponse> SdkBuilder<DescribeBackupVaultResponse.Builder,
,DescribeBackupVaultResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeBackupVaultResponse
-
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:backup-vault:aBackupVault
.backupVaultName
(String backupVaultName) The name of a logical container where backups are stored.creationDate
(Instant creationDate) The date and time that a backup vault 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) 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
.latestMpaApprovalTeamUpdate
(Consumer<LatestMpaApprovalTeamUpdate.Builder> latestMpaApprovalTeamUpdate) Information about the latest update to the MPA approval team association for this backup vault.latestMpaApprovalTeamUpdate
(LatestMpaApprovalTeamUpdate latestMpaApprovalTeamUpdate) Information about the latest update to the MPA approval team association for this backup vault.The date and time when Backup Vault Lock configuration cannot be changed or deleted.A Boolean that indicates whether Backup Vault Lock is currently protecting the 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.mpaApprovalTeamArn
(String mpaApprovalTeamArn) The ARN of the MPA approval team associated with this backup vault.mpaSessionArn
(String mpaSessionArn) The ARN of the MPA session associated with this backup vault.numberOfRecoveryPoints
(Long numberOfRecoveryPoints) The number of recovery points that are stored in a backup vault.sourceBackupVaultArn
(String sourceBackupVaultArn) The ARN of the source backup vault from which this restore access backup vault was created.vaultState
(String vaultState) The current state of the vault.->vaultState
(VaultState vaultState) The current state of the vault.->The type of vault described.The type of vault described.Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupResponse.Builder
build, responseMetadata, responseMetadata
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, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
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 Region where they are created.
- 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 Region where they are created.- 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:backup-vault:aBackupVault
.- Parameters:
backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vaultType
The type of vault described.
- Parameters:
vaultType
- The type of vault described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vaultType
The type of vault described.
- Parameters:
vaultType
- The type of vault described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vaultState
The current state of the vault.->
- Parameters:
vaultState
- The current state of the vault.->- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vaultState
The current state of the vault.->
- Parameters:
vaultState
- The current state of the vault.->- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
creationDate
- The date and time that a backup vault 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.
-
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.
Recovery point count value displayed in the console can be an approximation. Use
ListRecoveryPointsByBackupVault
API to obtain the exact count.- Parameters:
numberOfRecoveryPoints
- The number of recovery points that are stored in a backup vault.Recovery point count value displayed in the console can be an approximation. Use
ListRecoveryPointsByBackupVault
API to obtain the exact count.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- 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 will 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 will 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 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceBackupVaultArn
The ARN of the source backup vault from which this restore access backup vault was created.
- Parameters:
sourceBackupVaultArn
- The ARN of the source backup vault from which this restore access backup vault was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mpaApprovalTeamArn
The ARN of the MPA approval team associated with this backup vault.
- Parameters:
mpaApprovalTeamArn
- The ARN of the MPA approval team associated with this backup vault.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mpaSessionArn
The ARN of the MPA session associated with this backup vault.
- Parameters:
mpaSessionArn
- The ARN of the MPA session associated with this backup vault.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestMpaApprovalTeamUpdate
DescribeBackupVaultResponse.Builder latestMpaApprovalTeamUpdate(LatestMpaApprovalTeamUpdate latestMpaApprovalTeamUpdate) Information about the latest update to the MPA approval team association for this backup vault.
- Parameters:
latestMpaApprovalTeamUpdate
- Information about the latest update to the MPA approval team association for this backup vault.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestMpaApprovalTeamUpdate
default DescribeBackupVaultResponse.Builder latestMpaApprovalTeamUpdate(Consumer<LatestMpaApprovalTeamUpdate.Builder> latestMpaApprovalTeamUpdate) Information about the latest update to the MPA approval team association for this backup vault.
This is a convenience method that creates an instance of theLatestMpaApprovalTeamUpdate.Builder
avoiding the need to create one manually viaLatestMpaApprovalTeamUpdate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolatestMpaApprovalTeamUpdate(LatestMpaApprovalTeamUpdate)
.- Parameters:
latestMpaApprovalTeamUpdate
- a consumer that will call methods onLatestMpaApprovalTeamUpdate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-