You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Backup::Types::DescribeRecoveryPointOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_size_in_bytes ⇒ Integer

The size, in bytes, of a backup.

Returns:

  • (Integer) —

    The size, in bytes, of a backup.

#backup_vault_arn ⇒ String

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

Returns:

  • (String) —

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

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

Returns:

  • (String) —

    The name of a logical container where backups are stored.

#calculated_lifecycle ⇒ Types::CalculatedLifecycle

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

Returns:

#completion_date ⇒ Time

The date and time that a job to create 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:

  • (Time) —

    The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).

#created_by ⇒ Types::RecoveryPointCreator

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

Returns:

  • (Types::RecoveryPointCreator) —

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

#creation_date ⇒ Time

The date and time that 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:

  • (Time) —

    The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC).

#encryption_key_arn ⇒ String

The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Returns:

  • (String) —

    The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

#iam_role_arn ⇒ String

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

Returns:

  • (String) —

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

#is_encrypted ⇒ Boolean

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:

  • (Boolean) —

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

#last_restore_time ⇒ Time

The date and time that 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:

  • (Time) —

    The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC).

#lifecycle ⇒ Types::Lifecycle

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

Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” 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.

Returns:

  • (Types::Lifecycle) —

    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.

#recovery_point_arn ⇒ String

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

Returns:

  • (String) —

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

#resource_arn ⇒ String

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

Returns:

  • (String) —

    An ARN that uniquely identifies a saved resource.

#resource_type ⇒ String

The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

  • (String) —

    The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

#source_backup_vault_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same AWS account or Region, this value will be null.

Returns:

  • (String) —

    An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault.

#status ⇒ String

A status code specifying the state of the recovery point.

A partial status indicates that the recovery point was not successfully re-created and must be retried.

Possible values:

  • COMPLETED
  • PARTIAL
  • DELETING
  • EXPIRED

Returns:

  • (String) —

    A status code specifying the state of the recovery point.

#storage_class ⇒ String

Specifies the storage class of the recovery point. Valid values are WARM or COLD.

Possible values:

  • WARM
  • COLD
  • DELETED

Returns:

  • (String) —

    Specifies the storage class of the recovery point.