Class DescribeBackupVaultResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.backup.model.BackupResponse
software.amazon.awssdk.services.backup.model.DescribeBackupVaultResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeBackupVaultResponse.Builder,DescribeBackupVaultResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBackupVaultResponse extends BackupResponse implements ToCopyableBuilder<DescribeBackupVaultResponse.Builder,DescribeBackupVaultResponse>

  • Method Details

    • backupVaultName

      public final String 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:
      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.

    • backupVaultArn

      public final 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.

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

    • vaultType

      public final VaultType vaultType()

      The type of vault described.

      If the service returns an enum value that is not available in the current SDK version, vaultType will return VaultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultTypeAsString().

      Returns:
      The type of vault described.
      See Also:

    • vaultTypeAsString

      public final String vaultTypeAsString()

      The type of vault described.

      If the service returns an enum value that is not available in the current SDK version, vaultType will return VaultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultTypeAsString().

      Returns:
      The type of vault described.
      See Also:

    • vaultState

      public final VaultState vaultState()

      The current state of the vault.->

      If the service returns an enum value that is not available in the current SDK version, vaultState will return VaultState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultStateAsString().

      Returns:
      The current state of the vault.->
      See Also:

    • vaultStateAsString

      public final String vaultStateAsString()

      The current state of the vault.->

      If the service returns an enum value that is not available in the current SDK version, vaultState will return VaultState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultStateAsString().

      Returns:
      The current state of the vault.->
      See Also:

    • encryptionKeyArn

      public final 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.

      Returns:
      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.

    • creationDate

      public final Instant 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.

      Returns:
      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

      public final String 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:
      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.

    • numberOfRecoveryPoints

      public final Long 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:
      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.

    • locked

      public final Boolean 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:
      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.

    • minRetentionDays

      public final Long 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:
      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.

    • maxRetentionDays

      public final Long 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:
      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.

    • lockDate

      public final Instant 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:
      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.

    • sourceBackupVaultArn

      public final String sourceBackupVaultArn()

      The ARN of the source backup vault from which this restore access backup vault was created.

      Returns:
      The ARN of the source backup vault from which this restore access backup vault was created.

    • mpaApprovalTeamArn

      public final String mpaApprovalTeamArn()

      The ARN of the MPA approval team associated with this backup vault.

      Returns:
      The ARN of the MPA approval team associated with this backup vault.

    • mpaSessionArn

      public final String mpaSessionArn()

      The ARN of the MPA session associated with this backup vault.

      Returns:
      The ARN of the MPA session associated with this backup vault.

    • latestMpaApprovalTeamUpdate

      public final LatestMpaApprovalTeamUpdate latestMpaApprovalTeamUpdate()

      Information about the latest update to the MPA approval team association for this backup vault.

      Returns:
      Information about the latest update to the MPA approval team association for this backup vault.

    • toBuilder

      public DescribeBackupVaultResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeBackupVaultResponse.Builder,DescribeBackupVaultResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeBackupVaultResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeBackupVaultResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.