Class: Aws::Redshift::Types::RestoreStatus

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::RestoreStatus

Includes:

Structure

Defined in:

lib/aws-sdk-redshift/types.rb

Overview

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #current_restore_rate_in_mega_bytes_per_second ⇒ Float

  The number of megabytes per second being transferred from the backup storage.

• #elapsed_time_in_seconds ⇒ Integer

  The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

• #estimated_time_to_completion_in_seconds ⇒ Integer

  The estimate of the time remaining before the restore will complete.

• #progress_in_mega_bytes ⇒ Integer

  The number of megabytes that have been transferred from snapshot storage.

• #snapshot_size_in_mega_bytes ⇒ Integer

  The size of the set of snapshot data used to restore the cluster.

• #status ⇒ String

  The status of the restore action.

Instance Attribute Details

#current_restore_rate_in_mega_bytes_per_second ⇒ Float

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 node types.

Returns:

• (Float)

# File 'lib/aws-sdk-redshift/types.rb', line 10824

class RestoreStatus < Struct.new(
  :status,
  :current_restore_rate_in_mega_bytes_per_second,
  :snapshot_size_in_mega_bytes,
  :progress_in_mega_bytes,
  :elapsed_time_in_seconds,
  :estimated_time_to_completion_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#elapsed_time_in_seconds ⇒ Integer

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 node types.

Returns:

• (Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 10824

class RestoreStatus < Struct.new(
  :status,
  :current_restore_rate_in_mega_bytes_per_second,
  :snapshot_size_in_mega_bytes,
  :progress_in_mega_bytes,
  :elapsed_time_in_seconds,
  :estimated_time_to_completion_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_to_completion_in_seconds ⇒ Integer

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 node types.

Returns:

• (Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 10824

class RestoreStatus < Struct.new(
  :status,
  :current_restore_rate_in_mega_bytes_per_second,
  :snapshot_size_in_mega_bytes,
  :progress_in_mega_bytes,
  :elapsed_time_in_seconds,
  :estimated_time_to_completion_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#progress_in_mega_bytes ⇒ Integer

The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 node types.

Returns:

• (Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 10824

class RestoreStatus < Struct.new(
  :status,
  :current_restore_rate_in_mega_bytes_per_second,
  :snapshot_size_in_mega_bytes,
  :progress_in_mega_bytes,
  :elapsed_time_in_seconds,
  :estimated_time_to_completion_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_size_in_mega_bytes ⇒ Integer

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 node types.

Returns:

• (Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 10824

class RestoreStatus < Struct.new(
  :status,
  :current_restore_rate_in_mega_bytes_per_second,
  :snapshot_size_in_mega_bytes,
  :progress_in_mega_bytes,
  :elapsed_time_in_seconds,
  :estimated_time_to_completion_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the restore action. Returns starting, restoring, completed, or failed.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 10824

class RestoreStatus < Struct.new(
  :status,
  :current_restore_rate_in_mega_bytes_per_second,
  :snapshot_size_in_mega_bytes,
  :progress_in_mega_bytes,
  :elapsed_time_in_seconds,
  :estimated_time_to_completion_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end