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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_size_in_bytesInteger

The size, in bytes, of a backup.

Returns:

  • (Integer)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_arnString

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

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_nameString

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)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#calculated_lifecycleTypes::CalculatedLifecycle

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#completion_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.

Returns:

  • (Time)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#created_byTypes::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.



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_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.

Returns:

  • (Time)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arnString

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)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

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

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#is_encryptedBoolean

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)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_restore_timeTime

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)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycleTypes::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.

Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

Returns:



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arnString

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)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

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

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

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.

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_vault_arnString

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.

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

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

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end

#storage_classString

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

Returns:

  • (String)


2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2820

class DescribeRecoveryPointOutput < Struct.new(
  :recovery_point_arn,
  :backup_vault_name,
  :backup_vault_arn,
  :source_backup_vault_arn,
  :resource_arn,
  :resource_type,
  :created_by,
  :iam_role_arn,
  :status,
  :status_message,
  :creation_date,
  :completion_date,
  :backup_size_in_bytes,
  :calculated_lifecycle,
  :lifecycle,
  :encryption_key_arn,
  :is_encrypted,
  :storage_class,
  :last_restore_time)
  SENSITIVE = []
  include Aws::Structure
end