Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.Types.RestoreStatus

Description

Documentation

data RestoreStatus Source #

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

See: newRestoreStatus smart constructor.

Constructors

RestoreStatus'

Fields

currentRestoreRateInMegaBytesPerSecond :: Maybe Double
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 and DS2 node types.
elapsedTimeInSeconds :: Maybe 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 and DS2 node types.
estimatedTimeToCompletionInSeconds :: Maybe 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 and DS2 node types.
progressInMegaBytes :: Maybe Integer
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
snapshotSizeInMegaBytes :: Maybe Integer
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
status :: Maybe Text
The status of the restore action. Returns starting, restoring, completed, or failed.

Instances

Instances details

FromXML RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Methods parseXML :: [Node] -> Either String RestoreStatus #
Generic RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Associated Types type Rep RestoreStatus :: Type -> Type # Methods from :: RestoreStatus -> Rep RestoreStatus x # to :: Rep RestoreStatus x -> RestoreStatus #
Read RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Methods readsPrec :: Int -> ReadS RestoreStatus # readList :: ReadS [RestoreStatus] # readPrec :: ReadPrec RestoreStatus # readListPrec :: ReadPrec [RestoreStatus] #
Show RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Methods showsPrec :: Int -> RestoreStatus -> ShowS # show :: RestoreStatus -> String # showList :: [RestoreStatus] -> ShowS #
NFData RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Methods rnf :: RestoreStatus -> () #
Eq RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Methods (==) :: RestoreStatus -> RestoreStatus -> Bool # (/=) :: RestoreStatus -> RestoreStatus -> Bool #
Hashable RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus Methods hashWithSalt :: Int -> RestoreStatus -> Int # hash :: RestoreStatus -> Int #
type Rep RestoreStatus Source #
Instance details Defined in Amazonka.Redshift.Types.RestoreStatus type Rep RestoreStatus = D1 ('MetaData "RestoreStatus" "Amazonka.Redshift.Types.RestoreStatus" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "RestoreStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "currentRestoreRateInMegaBytesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "elapsedTimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "estimatedTimeToCompletionInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "progressInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "snapshotSizeInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newRestoreStatus :: RestoreStatus Source #

Create a value of RestoreStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:currentRestoreRateInMegaBytesPerSecond:RestoreStatus', restoreStatus_currentRestoreRateInMegaBytesPerSecond - 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 and DS2 node types.

$sel:elapsedTimeInSeconds:RestoreStatus', restoreStatus_elapsedTimeInSeconds - 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 and DS2 node types.

$sel:estimatedTimeToCompletionInSeconds:RestoreStatus', restoreStatus_estimatedTimeToCompletionInSeconds - 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 and DS2 node types.

$sel:progressInMegaBytes:RestoreStatus', restoreStatus_progressInMegaBytes - The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

$sel:snapshotSizeInMegaBytes:RestoreStatus', restoreStatus_snapshotSizeInMegaBytes - The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

$sel:status:RestoreStatus', restoreStatus_status - The status of the restore action. Returns starting, restoring, completed, or failed.

restoreStatus_currentRestoreRateInMegaBytesPerSecond :: Lens' RestoreStatus (Maybe Double) Source #

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 and DS2 node types.

restoreStatus_elapsedTimeInSeconds :: Lens' RestoreStatus (Maybe Integer) Source #

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 and DS2 node types.

restoreStatus_estimatedTimeToCompletionInSeconds :: Lens' RestoreStatus (Maybe Integer) Source #

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 and DS2 node types.

restoreStatus_progressInMegaBytes :: Lens' RestoreStatus (Maybe Integer) Source #

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

restoreStatus_snapshotSizeInMegaBytes :: Lens' RestoreStatus (Maybe Integer) Source #

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

restoreStatus_status :: Lens' RestoreStatus (Maybe Text) Source #

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