You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/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.

Instance Attribute Summary collapse

Instance Attribute Details

#current_restore_rate_in_mega_bytes_per_secondFloat

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

Returns:

  • (Float)


5866
5867
5868
5869
5870
5871
5872
5873
5874
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5866

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)
  include Aws::Structure
end

#elapsed_time_in_secondsInteger

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

Returns:

  • (Integer)


5866
5867
5868
5869
5870
5871
5872
5873
5874
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5866

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)
  include Aws::Structure
end

#estimated_time_to_completion_in_secondsInteger

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

Returns:

  • (Integer)


5866
5867
5868
5869
5870
5871
5872
5873
5874
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5866

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)
  include Aws::Structure
end

#progress_in_mega_bytesInteger

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

Returns:

  • (Integer)


5866
5867
5868
5869
5870
5871
5872
5873
5874
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5866

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)
  include Aws::Structure
end

#snapshot_size_in_mega_bytesInteger

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

Returns:

  • (Integer)


5866
5867
5868
5869
5870
5871
5872
5873
5874
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5866

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)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5866

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)
  include Aws::Structure
end