Class: Aws::Backup::Types::RecoveryPointByResource

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::RecoveryPointByResource

Defined in:

gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Contains detailed information about a saved recovery point.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #backup_size_bytes ⇒ Integer

  The size, in bytes, of a backup.

• #backup_vault_name ⇒ String

  The name of a logical container where backups are stored.

• #creation_date ⇒ Time

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

• #encryption_key_arn ⇒ String

  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.

• #index_status ⇒ String

  This is the current status for the backup index associated with the specified recovery point.

• #index_status_message ⇒ String

  A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.

• #is_parent ⇒ Boolean

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

• #parent_recovery_point_arn ⇒ String

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

• #recovery_point_arn ⇒ String

  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.

• #resource_name ⇒ String

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

• #status ⇒ String

  A status code specifying the state of the recovery point.

• #status_message ⇒ String

  A message explaining the current status of the recovery point.

• #vault_type ⇒ String

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

Instance Attribute Details

#backup_size_bytes ⇒ Integer

The size, in bytes, of a backup.

Returns:

• (Integer)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services Region where they are created.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

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:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#index_status ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#index_status_message ⇒ String

A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#is_parent ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#parent_recovery_point_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#resource_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

A status code specifying the state of the recovery point.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A message explaining the current status of the recovery point.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#vault_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7056

class RecoveryPointByResource < Struct.new(
  :recovery_point_arn,
  :creation_date,
  :status,
  :status_message,
  :encryption_key_arn,
  :backup_size_bytes,
  :backup_vault_name,
  :is_parent,
  :parent_recovery_point_arn,
  :resource_name,
  :vault_type,
  :index_status,
  :index_status_message)
  SENSITIVE = []
  include Aws::Structure
end