#[non_exhaustive]pub struct DescribeRecoveryPointOutput {Show 27 fields
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 initiation_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>,
pub parent_recovery_point_arn: Option<String>,
pub composite_member_identifier: Option<String>,
pub is_parent: bool,
pub resource_name: Option<String>,
pub vault_type: Option<VaultType>,
pub index_status: Option<IndexStatus>,
pub index_status_message: Option<String>,
/* private fields */
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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.
backup_vault_arn: Option<String>An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-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:backup-vault:aBackupVault. 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. For more information, see Recovery point status in the Backup Developer Guide.
-
CREATINGstatus indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point. -
AVAILABLEstatus indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use. -
PARTIALstatus indicates a composite recovery point has one or more nested recovery points that were not in the backup. -
EXPIREDstatus 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. -
STOPPEDstatus occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.To resolve
STOPPEDstatus, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.For SAP HANA on Amazon EC2
STOPPEDstatus occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
status_message: Option<String>A status message explaining the status of the recovery point.
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.
initiation_date: Option<DateTime>The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
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 “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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
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: boolA 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.
parent_recovery_point_arn: Option<String>This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
composite_member_identifier: Option<String>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.
is_parent: boolThis returns the boolean value that a recovery point is a parent (composite) job.
resource_name: Option<String>The name of the resource that belongs to the specified backup.
vault_type: Option<VaultType>The type of vault in which the described recovery point is stored.
index_status: Option<IndexStatus>This is the current status for the backup index associated with the specified recovery point.
Statuses are: PENDING | ACTIVE | FAILED | DELETING
A recovery point with an index that has the status of ACTIVE can be included in a search.
index_status_message: Option<String>A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Implementations§
Source§impl DescribeRecoveryPointOutput
impl DescribeRecoveryPointOutput
Sourcepub fn recovery_point_arn(&self) -> Option<&str>
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.
Sourcepub fn backup_vault_name(&self) -> Option<&str>
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.
Sourcepub fn backup_vault_arn(&self) -> Option<&str>
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:backup-vault:aBackupVault.
Sourcepub fn source_backup_vault_arn(&self) -> Option<&str>
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:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
Sourcepub fn resource_arn(&self) -> Option<&str>
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.
Sourcepub fn resource_type(&self) -> Option<&str>
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.
Sourcepub fn created_by(&self) -> Option<&RecoveryPointCreator>
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.
Sourcepub fn iam_role_arn(&self) -> Option<&str>
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.
Sourcepub fn status(&self) -> Option<&RecoveryPointStatus>
pub fn status(&self) -> Option<&RecoveryPointStatus>
A status code specifying the state of the recovery point. For more information, see Recovery point status in the Backup Developer Guide.
-
CREATINGstatus indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point. -
AVAILABLEstatus indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use. -
PARTIALstatus indicates a composite recovery point has one or more nested recovery points that were not in the backup. -
EXPIREDstatus 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. -
STOPPEDstatus occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.To resolve
STOPPEDstatus, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.For SAP HANA on Amazon EC2
STOPPEDstatus occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
A status message explaining the status of the recovery point.
Sourcepub fn creation_date(&self) -> Option<&DateTime>
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.
Sourcepub fn initiation_date(&self) -> Option<&DateTime>
pub fn initiation_date(&self) -> Option<&DateTime>
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
Sourcepub fn completion_date(&self) -> Option<&DateTime>
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.
Sourcepub fn backup_size_in_bytes(&self) -> Option<i64>
pub fn backup_size_in_bytes(&self) -> Option<i64>
The size, in bytes, of a backup.
Sourcepub fn calculated_lifecycle(&self) -> Option<&CalculatedLifecycle>
pub fn calculated_lifecycle(&self) -> Option<&CalculatedLifecycle>
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
Sourcepub fn lifecycle(&self) -> Option<&Lifecycle>
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 “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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
Sourcepub fn encryption_key_arn(&self) -> Option<&str>
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.
Sourcepub fn is_encrypted(&self) -> bool
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.
Sourcepub fn storage_class(&self) -> Option<&StorageClass>
pub fn storage_class(&self) -> Option<&StorageClass>
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
Sourcepub fn last_restore_time(&self) -> Option<&DateTime>
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.
Sourcepub fn parent_recovery_point_arn(&self) -> Option<&str>
pub fn parent_recovery_point_arn(&self) -> Option<&str>
This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Sourcepub fn composite_member_identifier(&self) -> Option<&str>
pub fn composite_member_identifier(&self) -> Option<&str>
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.
Sourcepub fn is_parent(&self) -> bool
pub fn is_parent(&self) -> bool
This returns the boolean value that a recovery point is a parent (composite) job.
Sourcepub fn resource_name(&self) -> Option<&str>
pub fn resource_name(&self) -> Option<&str>
The name of the resource that belongs to the specified backup.
Sourcepub fn vault_type(&self) -> Option<&VaultType>
pub fn vault_type(&self) -> Option<&VaultType>
The type of vault in which the described recovery point is stored.
Sourcepub fn index_status(&self) -> Option<&IndexStatus>
pub fn index_status(&self) -> Option<&IndexStatus>
This is the current status for the backup index associated with the specified recovery point.
Statuses are: PENDING | ACTIVE | FAILED | DELETING
A recovery point with an index that has the status of ACTIVE can be included in a search.
Sourcepub fn index_status_message(&self) -> Option<&str>
pub fn index_status_message(&self) -> Option<&str>
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Source§impl DescribeRecoveryPointOutput
impl DescribeRecoveryPointOutput
Sourcepub fn builder() -> DescribeRecoveryPointOutputBuilder
pub fn builder() -> DescribeRecoveryPointOutputBuilder
Creates a new builder-style object to manufacture DescribeRecoveryPointOutput.
Trait Implementations§
Source§impl Clone for DescribeRecoveryPointOutput
impl Clone for DescribeRecoveryPointOutput
Source§fn clone(&self) -> DescribeRecoveryPointOutput
fn clone(&self) -> DescribeRecoveryPointOutput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DescribeRecoveryPointOutput
impl Debug for DescribeRecoveryPointOutput
Source§impl PartialEq for DescribeRecoveryPointOutput
impl PartialEq for DescribeRecoveryPointOutput
Source§fn eq(&self, other: &DescribeRecoveryPointOutput) -> bool
fn eq(&self, other: &DescribeRecoveryPointOutput) -> bool
self and other values to be equal, and is used by ==.Source§impl RequestId for DescribeRecoveryPointOutput
impl RequestId for DescribeRecoveryPointOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for DescribeRecoveryPointOutput
Auto Trait Implementations§
impl Freeze for DescribeRecoveryPointOutput
impl RefUnwindSafe for DescribeRecoveryPointOutput
impl Send for DescribeRecoveryPointOutput
impl Sync for DescribeRecoveryPointOutput
impl Unpin for DescribeRecoveryPointOutput
impl UnwindSafe for DescribeRecoveryPointOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);