Package software.amazon.awssdk.services.backup.model

Class RecoveryPointByBackupVault

java.lang.Object
software.amazon.awssdk.services.backup.model.RecoveryPointByBackupVault
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>
@Generated("software.amazon.awssdk:codegen") public final class RecoveryPointByBackupVault extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>

Contains detailed information about the recovery points stored in a backup vault.

See Also:

  • Method Details

    • recoveryPointArn

      public final String recoveryPointArn()

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • 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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • backupVaultArn

      public final String backupVaultArn()

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

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

    • sourceBackupVaultArn

      public final String sourceBackupVaultArn()

      The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

      Returns:
      The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

    • resourceArn

      public final String resourceArn()

      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

      Returns:
      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • resourceType

      public final String resourceType()

      The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

      Returns:
      The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

    • createdBy

      public final RecoveryPointCreator createdBy()

      Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

      Returns:
      Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

    • iamRoleArn

      public final String iamRoleArn()

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      Returns:
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • status

      public final RecoveryPointStatus status()

      A status code specifying the state of the recovery point.

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

      Returns:
      A status code specifying the state of the recovery point.
      See Also:

    • statusAsString

      public final String statusAsString()

      A status code specifying the state of the recovery point.

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

      Returns:
      A status code specifying the state of the recovery point.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message explaining the reason of the recovery point deletion failure.

      Returns:
      A message explaining the reason of the recovery point deletion failure.

    • creationDate

      public final Instant creationDate()

      The date and time a recovery point 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 a recovery point 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.

    • completionDate

      public final Instant completionDate()

      The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate 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 a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • backupSizeInBytes

      public final Long backupSizeInBytes()

      The size, in bytes, of a backup.

      Returns:
      The size, in bytes, of a backup.

    • calculatedLifecycle

      public final CalculatedLifecycle calculatedLifecycle()

      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

      Returns:
      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

    • lifecycle

      public final Lifecycle lifecycle()

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

      Returns:
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

    • 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.

    • isEncrypted

      public final Boolean isEncrypted()

      A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

      Returns:
      A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

    • lastRestoreTime

      public final Instant lastRestoreTime()

      The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime 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 a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • parentRecoveryPointArn

      public final String parentRecoveryPointArn()

      This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

      Returns:
      This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

    • compositeMemberIdentifier

      public final String compositeMemberIdentifier()

      This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

      Returns:
      This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

    • isParent

      public final Boolean isParent()

      This is a boolean value indicating this is a parent (composite) recovery point.

      Returns:
      This is a boolean value indicating this is a parent (composite) recovery point.

    • resourceName

      public final String resourceName()

      This is the non-unique name of the resource that belongs to the specified backup.

      Returns:
      This is the non-unique name of the resource that belongs to the specified backup.

    • vaultType

      public final VaultType vaultType()

      This is the type of vault in which the described recovery point is stored.

      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:
      This is the type of vault in which the described recovery point is stored.
      See Also:

    • vaultTypeAsString

      public final String vaultTypeAsString()

      This is the type of vault in which the described recovery point is stored.

      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:
      This is the type of vault in which the described recovery point is stored.
      See Also:

    • toBuilder

      public RecoveryPointByBackupVault.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<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>
      Returns:
      a builder for type T

    • builder

      public static RecoveryPointByBackupVault.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.