Amazonka.RedshiftServerLess.Types.Snapshot

Documentation

data Snapshot

A snapshot object that contains databases.

See: newSnapshot smart constructor.

Constructors

Snapshot'

Fields

• accountsWithProvisionedRestoreAccess :: Maybe [Text]

  All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

• accountsWithRestoreAccess :: Maybe [Text]

  All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

• actualIncrementalBackupSizeInMegaBytes :: Maybe Double

  The size of the incremental backup in megabytes.

• adminUsername :: Maybe Text

  The username of the database within a snapshot.

• backupProgressInMegaBytes :: Maybe Double

  The size in megabytes of the data that has been backed up to a snapshot.

• currentBackupRateInMegaBytesPerSecond :: Maybe Double

  The rate at which data is backed up into a snapshot in megabytes per second.

• elapsedTimeInSeconds :: Maybe Integer

  The amount of time it took to back up data into a snapshot.

• estimatedSecondsToCompletion :: Maybe Integer

  The estimated amount of seconds until the snapshot completes backup.

• kmsKeyId :: Maybe Text

  The unique identifier of the KMS key used to encrypt the snapshot.

• namespaceArn :: Maybe Text

  The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

• namespaceName :: Maybe Text

  The name of the namepsace.

• ownerAccount :: Maybe Text

  The owner Amazon Web Services; account of the snapshot.

• snapshotArn :: Maybe Text

  The Amazon Resource Name (ARN) of the snapshot.

• snapshotCreateTime :: Maybe ISO8601

  The timestamp of when the snapshot was created.

• snapshotName :: Maybe Text

  The name of the snapshot.

• snapshotRemainingDays :: Maybe Int

  The amount of days until the snapshot is deleted.

• snapshotRetentionPeriod :: Maybe Int

  The period of time, in days, of how long the snapshot is retained.

• snapshotRetentionStartTime :: Maybe ISO8601

  The timestamp of when data within the snapshot started getting retained.

• status :: Maybe SnapshotStatus

  The status of the snapshot.

• totalBackupSizeInMegaBytes :: Maybe Double

  The total size, in megabytes, of how big the snapshot is.

Instances

FromJSON Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Methods

parseJSON :: Value -> Parser Snapshot

parseJSONList :: Value -> Parser [Snapshot]

Generic Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Associated Types

type Rep Snapshot :: Type -> Type

Methods

from :: Snapshot -> Rep Snapshot x

to :: Rep Snapshot x -> Snapshot

Read Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Methods

readsPrec :: Int -> ReadS Snapshot

readList :: ReadS [Snapshot]

readPrec :: ReadPrec Snapshot

readListPrec :: ReadPrec [Snapshot]

Show Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Methods

showsPrec :: Int -> Snapshot -> ShowS

show :: Snapshot -> String

showList :: [Snapshot] -> ShowS

NFData Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Methods

rnf :: Snapshot -> ()

Eq Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Methods

(==) :: Snapshot -> Snapshot -> Bool

(/=) :: Snapshot -> Snapshot -> Bool

Hashable Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

Methods

hashWithSalt :: Int -> Snapshot -> Int

hash :: Snapshot -> Int

type Rep Snapshot

Defined in Amazonka.RedshiftServerLess.Types.Snapshot

type Rep Snapshot = D1 ('MetaData "Snapshot" "Amazonka.RedshiftServerLess.Types.Snapshot" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "Snapshot'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountsWithProvisionedRestoreAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "accountsWithRestoreAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "actualIncrementalBackupSizeInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "adminUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupProgressInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) :*: ((S1 ('MetaSel ('Just "currentBackupRateInMegaBytesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "elapsedTimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "estimatedSecondsToCompletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "namespaceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "namespaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "snapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snapshotCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "snapshotRemainingDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "snapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "snapshotRetentionStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotStatus)) :*: S1 ('MetaSel ('Just "totalBackupSizeInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))))

newSnapshot :: Snapshot

Create a value of Snapshot 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:accountsWithProvisionedRestoreAccess:Snapshot', snapshot_accountsWithProvisionedRestoreAccess - All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

$sel:accountsWithRestoreAccess:Snapshot', snapshot_accountsWithRestoreAccess - All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

$sel:actualIncrementalBackupSizeInMegaBytes:Snapshot', snapshot_actualIncrementalBackupSizeInMegaBytes - The size of the incremental backup in megabytes.

$sel:adminUsername:Snapshot', snapshot_adminUsername - The username of the database within a snapshot.

$sel:backupProgressInMegaBytes:Snapshot', snapshot_backupProgressInMegaBytes - The size in megabytes of the data that has been backed up to a snapshot.

$sel:currentBackupRateInMegaBytesPerSecond:Snapshot', snapshot_currentBackupRateInMegaBytesPerSecond - The rate at which data is backed up into a snapshot in megabytes per second.

$sel:elapsedTimeInSeconds:Snapshot', snapshot_elapsedTimeInSeconds - The amount of time it took to back up data into a snapshot.

$sel:estimatedSecondsToCompletion:Snapshot', snapshot_estimatedSecondsToCompletion - The estimated amount of seconds until the snapshot completes backup.

$sel:kmsKeyId:Snapshot', snapshot_kmsKeyId - The unique identifier of the KMS key used to encrypt the snapshot.

$sel:namespaceArn:Snapshot', snapshot_namespaceArn - The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

$sel:namespaceName:Snapshot', snapshot_namespaceName - The name of the namepsace.

$sel:ownerAccount:Snapshot', snapshot_ownerAccount - The owner Amazon Web Services; account of the snapshot.

$sel:snapshotArn:Snapshot', snapshot_snapshotArn - The Amazon Resource Name (ARN) of the snapshot.

$sel:snapshotCreateTime:Snapshot', snapshot_snapshotCreateTime - The timestamp of when the snapshot was created.

$sel:snapshotName:Snapshot', snapshot_snapshotName - The name of the snapshot.

$sel:snapshotRemainingDays:Snapshot', snapshot_snapshotRemainingDays - The amount of days until the snapshot is deleted.

$sel:snapshotRetentionPeriod:Snapshot', snapshot_snapshotRetentionPeriod - The period of time, in days, of how long the snapshot is retained.

$sel:snapshotRetentionStartTime:Snapshot', snapshot_snapshotRetentionStartTime - The timestamp of when data within the snapshot started getting retained.

$sel:status:Snapshot', snapshot_status - The status of the snapshot.

$sel:totalBackupSizeInMegaBytes:Snapshot', snapshot_totalBackupSizeInMegaBytes - The total size, in megabytes, of how big the snapshot is.

snapshot_accountsWithProvisionedRestoreAccess :: Lens' Snapshot (Maybe [Text])

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

snapshot_accountsWithRestoreAccess :: Lens' Snapshot (Maybe [Text])

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

snapshot_actualIncrementalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double)

The size of the incremental backup in megabytes.

snapshot_adminUsername :: Lens' Snapshot (Maybe Text)

The username of the database within a snapshot.

snapshot_backupProgressInMegaBytes :: Lens' Snapshot (Maybe Double)

The size in megabytes of the data that has been backed up to a snapshot.

snapshot_currentBackupRateInMegaBytesPerSecond :: Lens' Snapshot (Maybe Double)

The rate at which data is backed up into a snapshot in megabytes per second.

snapshot_elapsedTimeInSeconds :: Lens' Snapshot (Maybe Integer)

The amount of time it took to back up data into a snapshot.

snapshot_estimatedSecondsToCompletion :: Lens' Snapshot (Maybe Integer)

The estimated amount of seconds until the snapshot completes backup.

snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text)

The unique identifier of the KMS key used to encrypt the snapshot.

snapshot_namespaceArn :: Lens' Snapshot (Maybe Text)

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

snapshot_namespaceName :: Lens' Snapshot (Maybe Text)

The name of the namepsace.

snapshot_ownerAccount :: Lens' Snapshot (Maybe Text)

The owner Amazon Web Services; account of the snapshot.

snapshot_snapshotArn :: Lens' Snapshot (Maybe Text)

The Amazon Resource Name (ARN) of the snapshot.

snapshot_snapshotCreateTime :: Lens' Snapshot (Maybe UTCTime)

The timestamp of when the snapshot was created.

snapshot_snapshotName :: Lens' Snapshot (Maybe Text)

The name of the snapshot.

snapshot_snapshotRemainingDays :: Lens' Snapshot (Maybe Int)

The amount of days until the snapshot is deleted.

snapshot_snapshotRetentionPeriod :: Lens' Snapshot (Maybe Int)

The period of time, in days, of how long the snapshot is retained.

snapshot_snapshotRetentionStartTime :: Lens' Snapshot (Maybe UTCTime)

The timestamp of when data within the snapshot started getting retained.

snapshot_status :: Lens' Snapshot (Maybe SnapshotStatus)

The status of the snapshot.

snapshot_totalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double)

The total size, in megabytes, of how big the snapshot is.