Struct aws_sdk_backup::output::DescribeRecoveryPointOutput

#[non_exhaustive]
pub struct DescribeRecoveryPointOutput {

    pub recovery_point_arn: Option<String>,
    pub backup_vault_name: Option<String>,
    pub backup_vault_arn: Option<String>,
    pub source_backup_vault_arn: Option<String>,
    pub resource_arn: Option<String>,
    pub resource_type: Option<String>,
    pub created_by: Option<RecoveryPointCreator>,
    pub iam_role_arn: Option<String>,
    pub status: Option<RecoveryPointStatus>,
    pub status_message: Option<String>,
    pub creation_date: Option<DateTime>,
    pub completion_date: Option<DateTime>,
    pub backup_size_in_bytes: Option<i64>,
    pub calculated_lifecycle: Option<CalculatedLifecycle>,
    pub lifecycle: Option<Lifecycle>,
    pub encryption_key_arn: Option<String>,
    pub is_encrypted: bool,
    pub storage_class: Option<StorageClass>,
    pub last_restore_time: Option<DateTime>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

recovery_point_arn: Option<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.

backup_vault_name: Option<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.

backup_vault_arn: Option<String>

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

source_backup_vault_arn: Option<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 Amazon Web Services account or Region, this value will be null.

resource_arn: Option<String>

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

resource_type: Option<String>

The type of Amazon Web Services 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.

created_by: Option<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.

iam_role_arn: Option<String>

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

status: Option<RecoveryPointStatus>

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

status_message: Option<String>

A status message explaining the reason for the recovery point deletion failure.

creation_date: Option<DateTime>

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.

completion_date: Option<DateTime>

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.

backup_size_in_bytes: Option<i64>

The size, in bytes, of a backup.

calculated_lifecycle: Option<CalculatedLifecycle>

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

lifecycle: Option<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 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

encryption_key_arn: Option<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.

is_encrypted: bool

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

storage_class: Option<StorageClass>

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

last_restore_time: Option<DateTime>

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.

Implementations

impl DescribeRecoveryPointOutput

pub fn recovery_point_arn(&self) -> Option<&str>

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

pub fn backup_vault_name(&self) -> Option<&str>

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.

pub fn backup_vault_arn(&self) -> Option<&str>

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

pub fn source_backup_vault_arn(&self) -> Option<&str>

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 Amazon Web Services account or Region, this value will be null.

pub fn resource_arn(&self) -> Option<&str>

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

pub fn resource_type(&self) -> Option<&str>

The type of Amazon Web Services 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.

pub fn created_by(&self) -> Option<&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.

pub fn iam_role_arn(&self) -> Option<&str>

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

pub fn status(&self) -> Option<&RecoveryPointStatus>

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

pub fn status_message(&self) -> Option<&str>

A status message explaining the reason for the recovery point deletion failure.

pub fn creation_date(&self) -> Option<&DateTime>

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.

pub fn completion_date(&self) -> Option<&DateTime>

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.

pub fn backup_size_in_bytes(&self) -> Option<i64>

The size, in bytes, of a backup.

pub fn calculated_lifecycle(&self) -> Option<&CalculatedLifecycle>

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

pub fn lifecycle(&self) -> Option<&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 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

pub fn encryption_key_arn(&self) -> Option<&str>

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.

pub fn is_encrypted(&self) -> bool

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

pub fn storage_class(&self) -> Option<&StorageClass>

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

pub fn last_restore_time(&self) -> Option<&DateTime>

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.

impl DescribeRecoveryPointOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeRecoveryPointOutput

Trait Implementations

impl Clone for DescribeRecoveryPointOutput

fn clone(&self) -> DescribeRecoveryPointOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeRecoveryPointOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DescribeRecoveryPointOutput> for DescribeRecoveryPointOutput

fn eq(&self, other: &DescribeRecoveryPointOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeRecoveryPointOutput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeRecoveryPointOutput